default | typed-struct

Factory of structures. You can define your data structure by chaining the appropriate method calls.

export default class Struct

Type parameters

T = {}
ClassName: string = "Structure"
HasCRC: boolean = false

Hierarchy

default

Constructors

constructor

new default<T, ClassName, HasCRC>(defaultClassName?: ClassName): default<T, ClassName, HasCRC>

- Defined in struct.ts:1029
Create a factory for the structure with the specified default name if given. This name can be changed when calling the method default.compile

Type parameters
- T = {}
- ClassName: string = "Structure"
- HasCRC: boolean = false
Parameters
- Optional defaultClassName: ClassName
Returns default<T, ClassName, HasCRC>

Methods

BCD

BCD<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1375
defines a single-byte binary-coded decimal

Type parameters
- N: string
- R: number
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

BigInt64Array

BigInt64Array<N>(name: N | N[], length?: number): ExtendStruct<T, ClassName, N, BigInt64Array, false, true>

- Defined in struct.ts:1618
defines a BigInt64Array typed array represents an array of 64-bit signed integers.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional length: number
  
  the number of elements
Returns ExtendStruct<T, ClassName, N, BigInt64Array, false, true>

BigInt64BE

BigInt64BE<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1289
defines a signed, big-endian 64-bit integer field

Type parameters
- N: string
- R: bigint
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

BigInt64LE

BigInt64LE<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1275
defines a signed, little-endian 64-bit integer field

Type parameters
- N: string
- R: bigint
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

BigUInt64Array

BigUInt64Array<N>(name: N | N[], length?: number): ExtendStruct<T, ClassName, N, BigUint64Array, false, true>

- Defined in struct.ts:1630
defines a BigUint64Array typed array represents an array of 64-bit unsigned integers.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional length: number
  
  the number of elements
Returns ExtendStruct<T, ClassName, N, BigUint64Array, false, true>

BigUInt64BE

BigUInt64BE<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1318
defines an unsigned, big-endian 64-bit integer field

Type parameters
- N: string
- R: bigint
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

BigUInt64LE

BigUInt64LE<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1304
defines an unsigned, little-endian 64-bit integer field

Type parameters
- N: string
- R: bigint
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

Bits16

Bits16<N>(fields: Record<N, BitMaskN<16>>): ExtendStruct<T, ClassName, N, number, false, false>

- Defined in struct.ts:1410
defines unsigned bit fields on two bytes

Type parameters
- N: string
Parameters
- fields: Record<N, BitMaskN<16>>
  
  an object with the name of the fields and their BitMask
Returns ExtendStruct<T, ClassName, N, number, false, false>

Bits32

Bits32<N>(fields: Record<N, BitMaskN<32>>): ExtendStruct<T, ClassName, N, number, false, false>

- Defined in struct.ts:1418
defines unsigned bit fields on four bytes

Type parameters
- N: string
Parameters
- fields: Record<N, BitMaskN<32>>
  
  an object with the name of the fields and their BitMask
Returns ExtendStruct<T, ClassName, N, number, false, false>

Bits8

Bits8<N>(fields: Record<N, BitMaskN<8>>): ExtendStruct<T, ClassName, N, number, false, false>

- Defined in struct.ts:1402
defines unsigned bit fields on one byte

Type parameters
- N: string
Parameters
- fields: Record<N, BitMaskN<8>>
  
  an object with the name of the fields and their BitMask
Returns ExtendStruct<T, ClassName, N, number, false, false>

Boolean16

Boolean16<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1347
defines a 16-bit boolean field

Type parameters
- N: string
- R: boolean
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

Boolean32

Boolean32<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1361
defines a 32-bit boolean field

Type parameters
- N: string
- R: boolean
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

Boolean8

Boolean8<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1333
defines an 8-bit boolean field

Type parameters
- N: string
- R: boolean
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

Buffer

Buffer<N>(name: N | N[], length?: number): ExtendStruct<T, ClassName, N, Buffer, false, true>

- Defined in struct.ts:1427
defines a buffer field of length bytes

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional length: number
  
  The desired length of the Buffer
Returns ExtendStruct<T, ClassName, N, Buffer, false, true>

CRC16BE

CRC16BE<N>(name: N | N[]): ExtendStruct<T, ClassName, N, number, false, false>
CRC16BE<N>(name: N | N[], calc: CRCCalc, initial?: number): ExtendStruct<T, ClassName, N, number, true, false>
CRC16BE<N>(name: N, opts: CRCOpts): ExtendStruct<T, ClassName, N, number, true, false>

- Defined in struct.ts:1785
The last two bytes in the structure storing unsigned, big-endian 16-bit integer usually used as a checksum. Typically, used for variable length structures.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
Returns ExtendStruct<T, ClassName, N, number, false, false>
- Defined in struct.ts:1794
The last two bytes in the structure storing unsigned, big-endian 16-bit integer usually used as a checksum. Typically, used for variable length structures.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- calc: CRCCalc
  
  checksum function
- Optional initial: number
  
  initial value, default 0.
Returns ExtendStruct<T, ClassName, N, number, true, false>
- Defined in struct.ts:1806
The last two bytes in the structure storing unsigned, big-endian 16-bit integer usually used as a checksum. Typically, used for variable length structures.

Type parameters
- N: string
Parameters
- name: N
  
  The field name or aliases
- opts: CRCOpts
  
  checksum function parameters
Returns ExtendStruct<T, ClassName, N, number, true, false>

CRC16LE

CRC16LE<N>(name: N | N[]): ExtendStruct<T, ClassName, N, number, false, false>
CRC16LE<N>(name: N | N[], calc: CRCCalc, initial?: number): ExtendStruct<T, ClassName, N, number, true, false>
CRC16LE<N>(name: N, opts: CRCOpts): ExtendStruct<T, ClassName, N, number, true, false>

- Defined in struct.ts:1749
The last two bytes in the structure storing unsigned, little-endian 16-bit integer usually used as a checksum. Typically, used for variable length structures.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
Returns ExtendStruct<T, ClassName, N, number, false, false>
- Defined in struct.ts:1758
The last two bytes in the structure storing unsigned, little-endian 16-bit integer usually used as a checksum. Typically, used for variable length structures.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- calc: CRCCalc
  
  checksum function
- Optional initial: number
  
  initial value, default 0.
Returns ExtendStruct<T, ClassName, N, number, true, false>
- Defined in struct.ts:1770
The last two bytes in the structure storing unsigned, little-endian 16-bit integer usually used as a checksum. Typically, used for variable length structures.

Type parameters
- N: string
Parameters
- name: N
  
  The field name or aliases
- opts: CRCOpts
  
  checksum function parameters
Returns ExtendStruct<T, ClassName, N, number, true, false>

CRC32BE

CRC32BE<N>(name: N | N[]): ExtendStruct<T, ClassName, N, number, false, false>
CRC32BE<N>(name: N | N[], calc: CRCCalc, initial?: number): ExtendStruct<T, ClassName, N, number, true, false>
CRC32BE<N>(name: N, opts: CRCOpts): ExtendStruct<T, ClassName, N, number, true, false>

- Defined in struct.ts:1857
The last four bytes in the structure storing unsigned, big-endian 32-bit integer usually used as a checksum. Typically, used for variable length structures.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
Returns ExtendStruct<T, ClassName, N, number, false, false>
- Defined in struct.ts:1866
The last four bytes in the structure storing unsigned, big-endian 32-bit integer usually used as a checksum. Typically, used for variable length structures.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- calc: CRCCalc
  
  checksum function
- Optional initial: number
  
  initial value, default 0.
Returns ExtendStruct<T, ClassName, N, number, true, false>
- Defined in struct.ts:1878
The last four bytes in the structure storing unsigned, big-endian 32-bit integer usually used as a checksum. Typically, used for variable length structures.

Type parameters
- N: string
Parameters
- name: N
  
  The field name or aliases
- opts: CRCOpts
  
  checksum function parameters
Returns ExtendStruct<T, ClassName, N, number, true, false>

CRC32LE

CRC32LE<N>(name: N | N[]): ExtendStruct<T, ClassName, N, number, false, false>
CRC32LE<N>(name: N | N[], calc: CRCCalc, initial?: number): ExtendStruct<T, ClassName, N, number, true, false>
CRC32LE<N>(name: N, opts: CRCOpts): ExtendStruct<T, ClassName, N, number, true, false>

- Defined in struct.ts:1821
The last four bytes in the structure storing unsigned, little-endian 32-bit integer usually used as a checksum. Typically, used for variable length structures.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
Returns ExtendStruct<T, ClassName, N, number, false, false>
- Defined in struct.ts:1830
The last four bytes in the structure storing unsigned, little-endian 32-bit integer usually used as a checksum. Typically, used for variable length structures.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- calc: CRCCalc
  
  checksum function
- Optional initial: number
  
  initial value, default 0.
Returns ExtendStruct<T, ClassName, N, number, true, false>
- Defined in struct.ts:1842
The last four bytes in the structure storing unsigned, little-endian 32-bit integer usually used as a checksum. Typically, used for variable length structures.

Type parameters
- N: string
Parameters
- name: N
  
  The field name or aliases
- opts: CRCOpts
  
  checksum function parameters
Returns ExtendStruct<T, ClassName, N, number, true, false>

CRC8

CRC8<N>(name: N | N[]): ExtendStruct<T, ClassName, N, number, false, false>
CRC8<N>(name: N | N[], calc: CRCCalc, initial?: number): ExtendStruct<T, ClassName, N, number, true, false>
CRC8<N>(name: N, opts: CRCOpts): ExtendStruct<T, ClassName, N, number, true, false>

- Defined in struct.ts:1713
The last byte in the structure, usually used as a checksum. Typically, used for variable length structures.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
Returns ExtendStruct<T, ClassName, N, number, false, false>
- Defined in struct.ts:1722
The last byte in the structure, usually used as a checksum. Typically, used for variable length structures.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- calc: CRCCalc
  
  checksum function
- Optional initial: number
  
  initial value, default 0.
Returns ExtendStruct<T, ClassName, N, number, true, false>
- Defined in struct.ts:1734
The last byte in the structure, usually used as a checksum. Typically, used for variable length structures.

Type parameters
- N: string
Parameters
- name: N
  
  The field name or aliases
- opts: CRCOpts
  
  checksum function parameters
Returns ExtendStruct<T, ClassName, N, number, true, false>

Custom

Custom<N, ReturnType>(name: N | N[], size: undefined | number, getter: Getter<ReturnType>): ExtendStruct<T, ClassName, N, ReturnType, false, true>
Custom<N, ReturnType>(name: N | N[], size: undefined | number, getter: Getter<ReturnType>, setter: Setter<ReturnType>): ExtendStruct<T, ClassName, N, ReturnType, false, false>

- Defined in struct.ts:1671
Type parameters
- N: string
- ReturnType
Parameters
- name: N | N[]
- size: undefined | number
- getter: Getter<ReturnType>
Returns ExtendStruct<T, ClassName, N, ReturnType, false, true>
- Defined in struct.ts:1686
defines a field with a custom getter and setter

Type parameters
- N: string
- ReturnType
Parameters
- name: N | N[]
  
  The field name or aliases
- size: undefined | number
  
  The field size
- getter: Getter<ReturnType>
  
  a function which serves as a getter for the property, or undefined if there is no getter.
- setter: Setter<ReturnType>
  
  a function which serves as a setter for the property, or undefined if there is no setter.
Returns ExtendStruct<T, ClassName, N, ReturnType, false, false>

Float32Array

Float32Array<N>(name: N | N[], length?: number): ExtendStruct<T, ClassName, N, Float32Array, false, true>

- Defined in struct.ts:1595
defines a Float32Array typed array represents an array of 32-bit floating numbers.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional length: number
  
  the number of elements
Returns ExtendStruct<T, ClassName, N, Float32Array, false, true>

Float32BE

Float32BE<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1245
defines a 32-bit, big-endian float field

Type parameters
- N: string
- R: number
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

Float32LE

Float32LE<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1217
defines a 32-bit, little-endian float field

Type parameters
- N: string
- R: number
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

Float64Array

Float64Array<N>(name: N | N[], length?: number): ExtendStruct<T, ClassName, N, Float64Array, false, true>

- Defined in struct.ts:1606
defines a Float64Array typed array represents an array of 64-bit floating numbers.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional length: number
  
  the number of elements
Returns ExtendStruct<T, ClassName, N, Float64Array, false, true>

Float64BE

Float64BE<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1260
defines a 64-bit, big-endian float field

Type parameters
- N: string
- R: number
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

Float64LE

Float64LE<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1231
defines a 64-bit, little-endian float field

Type parameters
- N: string
- R: number
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

Int16Array

Int16Array<N>(name: N | N[], length?: number): ExtendStruct<T, ClassName, N, Int16Array, false, true>

- Defined in struct.ts:1550
defines a Int16Array typed array represents an array of twos-complement 16-bit signed integers.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional length: number
  
  the number of elements
Returns ExtendStruct<T, ClassName, N, Int16Array, false, true>

Int16BE

Int16BE<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1157
defines a signed, big-endian 16-bit integer field

Type parameters
- N: string
- R: number
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

Int16LE

Int16LE<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1101
defines a signed, little-endian 16-bit integer field

Type parameters
- N: string
- R: number
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

Int32Array

Int32Array<N>(name: N | N[], length?: number): ExtendStruct<T, ClassName, N, Int32Array, false, true>

- Defined in struct.ts:1573
defines a Int32Array typed array represents an array of twos-complement 32-bit signed integers.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional length: number
  
  the number of elements
Returns ExtendStruct<T, ClassName, N, Int32Array, false, true>

Int32BE

Int32BE<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1187
defines a signed, big-endian 32-bit integer field

Type parameters
- N: string
- R: number
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

Int32LE

Int32LE<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1129
defines a signed, little-endian 32-bit integer field

Type parameters
- N: string
- R: number
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

Int8

Int8<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1073
defines a signed, 8-bit integer field

Type parameters
- N: string
- R: number
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

Int8Array

Int8Array<N>(name: N | N[], length?: number): ExtendStruct<T, ClassName, N, Int8Array, false, true>

- Defined in struct.ts:1528
defines a Int8Array typed array represents an array of twos-complement 8-bit signed integers.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional length: number
  
  the number of elements
Returns ExtendStruct<T, ClassName, N, Int8Array, false, true>

String

String<N>(name: N | N[]): ExtendStruct<T, ClassName, N, string, false, false>
String<N>(name: N | N[], length: number): ExtendStruct<T, ClassName, N, string, false, false>
String<N>(name: N | N[], encoding: string): ExtendStruct<T, ClassName, N, string, false, false>
String<N>(name: N | N[], length: number, encoding: string): ExtendStruct<T, ClassName, N, string, false, false>
String<N>(name: N | N[], encoding: string, length: number): ExtendStruct<T, ClassName, N, string, false, false>
String<N, R>(name: N | N[], opts: StringOpts<R>): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1439
defines a tailed string field

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
Returns ExtendStruct<T, ClassName, N, string, false, false>
- Defined in struct.ts:1446
defines a string field of length bytes

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- length: number
  
  The byte length of a string
Returns ExtendStruct<T, ClassName, N, string, false, false>
- Defined in struct.ts:1455
defines an encoded string field

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- encoding: string
  
  The encoding of string. Default: utf8. To use the full set of encodings install iconv-lite package
Returns ExtendStruct<T, ClassName, N, string, false, false>
- Defined in struct.ts:1465
defines an encoded string field of length bytes

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- length: number
  
  The byte length of a string
- encoding: string
  
  The encoding of string. Default: utf8. To use the full set of encodings install iconv-lite package
Returns ExtendStruct<T, ClassName, N, string, false, false>
- Defined in struct.ts:1479
defines an encoded string field of length bytes

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- encoding: string
  
  The encoding of string. Default: utf8. To use the full set of encodings install iconv-lite package
- length: number
  
  The byte length of a string
Returns ExtendStruct<T, ClassName, N, string, false, false>
- Defined in struct.ts:1490
defines a string field

Type parameters
- N: string
- R: string
Parameters
- name: N | N[]
  
  The field name or aliases
- opts: StringOpts<R>
  
  The string options
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

StringArray

StringArray<N>(name: N | N[], opts: { encoding?: string; length: number; lines: number }): ExtendStruct<T, ClassName, N, string[], false, true>

- Defined in struct.ts:1659
defines a string array field

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- opts: { encoding?: string; length: number; lines: number }
  
  The string array options
  - Optional encoding?: string
    
    The encoding of string. Default: utf8. To use the full set of encodings install iconv-lite package
  - length: number
  - lines: number
    
    the number of rows in the string array
Returns ExtendStruct<T, ClassName, N, string[], false, true>

Struct

Struct<N, S, StructClass>(name: N | N[], struct: StructConstructor<Item<S>, StructClass>): ExtendStruct<T, ClassName, N, S, false, S extends AssignableTypes ? false : true>

- Defined in struct.ts:1389
defines a nested structure

Type parameters
- N: string
- S
- StructClass: string
Parameters
- name: N | N[]
  
  The field name or aliases
- struct: StructConstructor<Item<S>, StructClass>
  
  structure factory
Returns ExtendStruct<T, ClassName, N, S, false, S extends AssignableTypes ? false : true>

StructArray

StructArray<N, S, StructClass>(name: N | N[], struct: StructConstructor<S, StructClass>, length?: number): ExtendStruct<T, ClassName, N, S[], false, true>

- Defined in struct.ts:1642
defines an array of elements of a typed struct

Type parameters
- N: string
- S
- StructClass: string
Parameters
- name: N | N[]
  
  The field name or aliases
- struct: StructConstructor<S, StructClass>
  
  The custom typed struct
- Optional length: number
  
  the number of elements
Returns ExtendStruct<T, ClassName, N, S[], false, true>

UInt16Array

UInt16Array<N>(name: N | N[], length?: number): ExtendStruct<T, ClassName, N, Uint16Array, false, true>

- Defined in struct.ts:1561
defines a Uint16Array typed array represents an array of 16-bit unsigned integers.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional length: number
  
  the number of elements
Returns ExtendStruct<T, ClassName, N, Uint16Array, false, true>

UInt16BE

UInt16BE<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1172
defines an unsigned, big-endian 16-bit integer field

Type parameters
- N: string
- R: number
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

UInt16LE

UInt16LE<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1115
defines an unsigned, little-endian 16-bit integer field

Type parameters
- N: string
- R: number
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

UInt32Array

UInt32Array<N>(name: N | N[], length?: number): ExtendStruct<T, ClassName, N, Uint32Array, false, true>

- Defined in struct.ts:1584
defines a Uint32Array typed array represents an array of 32-bit unsigned integers.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional length: number
  
  the number of elements
Returns ExtendStruct<T, ClassName, N, Uint32Array, false, true>

UInt32BE

UInt32BE<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1202
defines an unsigned, big-endian 32-bit integer field

Type parameters
- N: string
- R: number
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

UInt32LE

UInt32LE<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1143
defines an unsigned, little-endian 32-bit integer field

Type parameters
- N: string
- R: number
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

UInt8

UInt8<N, R>(name: N | N[], literal?: R): ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

- Defined in struct.ts:1087
defines an unsigned, 8-bit integer field

Type parameters
- N: string
- R: number
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional literal: R
  
  The fixed value
Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

UInt8Array

UInt8Array<N>(name: N | N[], length?: number): ExtendStruct<T, ClassName, N, Uint8Array, false, true>

- Defined in struct.ts:1538
defines a Uint8Array typed array represents an array of 8-bit unsigned integers.

Type parameters
- N: string
Parameters
- name: N | N[]
  
  The field name or aliases
- Optional length: number
  
  the number of elements
Returns ExtendStruct<T, ClassName, N, Uint8Array, false, true>

align2

align2(): default<T, ClassName, HasCRC>

- Defined in struct.ts:1921
Align the current pointer to a two-byte boundary

Returns default<T, ClassName, HasCRC>

align4

align4(): default<T, ClassName, HasCRC>

- Defined in struct.ts:1929
Align the current pointer to a four-byte boundary

Returns default<T, ClassName, HasCRC>

align8

align8(): default<T, ClassName, HasCRC>

- Defined in struct.ts:1938
Align the current pointer to an eight-byte boundary

Returns default<T, ClassName, HasCRC>

back

back(steps?: number): default<T, ClassName, HasCRC>

- Defined in struct.ts:1907
Move the current pointer in the buffer to the offset of the property that was N steps back.

see
default.seek

Parameters
- steps: number = 1
  
  the number of steps back, if the value is 0 then the pointer will point to the beginning of the buffer
Returns default<T, ClassName, HasCRC>

compile

compile(className?: undefined | string): ConditionalExtend<StructConstructor<{ [ P in string | number | symbol]: T[P] }, ClassName>, CRC<StructConstructor<{ [ P in string | number | symbol]: T[P] }, ClassName>>, HasCRC>

- Defined in struct.ts:1948
Create structure constructor

Parameters
- className: undefined | string = ...
  
  The constructor name
Returns ConditionalExtend<StructConstructor<{ [ P in string | number | symbol]: T[P] }, ClassName>, CRC<StructConstructor<{ [ P in string | number | symbol]: T[P] }, ClassName>>, HasCRC>

getOffsetOf

getOffsetOf(name: keyof T): undefined | number

- Defined in struct.ts:1058
Returns the offset in bytes from the beginning of the structure of the specified field

Parameters
- name: keyof T
  
  The field name or aliases
Returns undefined | number

getOffsets

getOffsets(): Record<keyof T, number>

- Defined in struct.ts:1063
Returns an object where each property stores its offset

Returns Record<keyof T, number>

getSize

getSize(): number

- Defined in struct.ts:1052
The current size of the structure in bytes

Returns number

seek

seek(bytes: number): default<T, ClassName, HasCRC>

- Defined in struct.ts:1895
Skip the specified number of bytes. If the value is negative, the pointer in the buffer will move backward, if the value is 0 then the pointer will point to the end of the current buffer.

see
default.back

Parameters
- bytes: number
Returns default<T, ClassName, HasCRC>

Static raw

raw<S>(structure: S): Buffer

- Defined in struct.ts:1046
Returns the underlying buffer of the structure

Type parameters
- S: StructGuard<string>
Parameters
- structure: S
Returns Buffer

Type parameters

T = {}

ClassName: string = "Structure"

HasCRC: boolean = false

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type parameters

T = {}

ClassName: string = "Structure"

HasCRC: boolean = false

Parameters

Optional defaultClassName: ClassName

Returns default<T, ClassName, HasCRC>

Methods

BCD

Type parameters

N: string

R: number

Parameters

name: N | N[]

Optional literal: R

Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

BigInt64Array

Type parameters

N: string

Parameters

name: N | N[]

Optional length: number

Returns ExtendStruct<T, ClassName, N, BigInt64Array, false, true>

BigInt64BE

Type parameters

N: string

R: bigint

Parameters

name: N | N[]

Optional literal: R

Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

BigInt64LE

Type parameters

N: string

R: bigint

Parameters

name: N | N[]

Optional literal: R

Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

BigUInt64Array

Type parameters

N: string

Parameters

name: N | N[]

Optional length: number

Returns ExtendStruct<T, ClassName, N, BigUint64Array, false, true>

BigUInt64BE

Type parameters

N: string

R: bigint

Parameters

name: N | N[]

Optional literal: R

Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

BigUInt64LE

Type parameters

N: string

R: bigint

Parameters

name: N | N[]

Optional literal: R

Returns ExtendStruct<T, ClassName, N, R, false, R extends AssignableTypes ? false : true>

Bits16

Type parameters

N: string

Parameters

fields: Record<N, BitMaskN<16>>

Returns ExtendStruct<T, ClassName, N, number, false, false>

Bits32

Type parameters