Class StructType<Obj, FT>

Type Parameters

Obj
FT extends {
[K in keyof Obj]: [K, SimpleType<Obj[K]>]
}[keyof Obj][]

Hierarchy (view full)

AdvancedType<Obj, StructType<Obj, FT>>
- StructType

Index

Constructors

Properties

ffiType ffiTypeStruct fields name size

Methods

fromBuffer toBuffer

Constructors

constructor

new StructType<Obj, FT>(fields, name): StructType<Obj, FT>
Type Parameters
- Obj
- FT extends {
  [K in string | number | symbol]: [K, SimpleType<Obj[K]>]
  }[keyof Obj][]
Parameters
- fields: FT
- name: string
Returns StructType<Obj, FT>
Overrides AdvancedType.constructor

Properties

`Readonly`ffiType

ffiType: StructType<Obj, FT>

`Readonly`ffiTypeStruct

ffiTypeStruct: SimpleType<Obj>

`Readonly`fields

fields: FT

`Readonly`name

name: string

`Readonly`size

size: number

Methods

fromBuffer

fromBuffer(buffer, ctx?): Obj
Parameters
- buffer: Uint8Array
- Optionalctx: {}
Returns Obj
Inherited from AdvancedType.fromBuffer

toBuffer

toBuffer(data, ctx?): Uint8Array
Parameters
- data: Obj
- Optionalctx: {}
Returns Uint8Array
Inherited from AdvancedType.toBuffer