Class Packet<T, U>

Capture fields from a packet in a way that allows accessing the previously- read fields while reading subsequent fields.

Type Parameters

T extends object
Structure of the packet.
U = object
Structure for other temporary fields that you want to reference, but don't want in the final packet.

Index

Constructors

constructor

new Packet<T extends object, U = object>(reader: DataViewReader): Packet<T, U>
Type Parameters
- T extends object
- U = object
Parameters
- reader: DataViewReader
Returns Packet<T, U>
- Defined in packet.ts:56

Accessors

left

get left(): number
How many bytes are left to be read?

Returns number
- Defined in packet.ts:83

offset

get offset(): number
The current offset into the reader.

Returns number
- Defined in packet.ts:74

packet

get packet(): T
Packet. Only the fields that you have already read may be accessed.

Returns T
Possibly-incomplete packet, even though the type is complete.
- Defined in packet.ts:65

temp

get temp(): U
Temporary storage. Only the fields that you have already read may be accessed.

Returns U
Possibly-incomplete temp data, even though the type is complete.
- Defined in packet.ts:93

Methods

ascii

ascii(name: keyof T, len: number, opts?: NotTemp<string>): this
Store some number of bytes, interpreted as an ASCII string.
Parameters
- name: keyof T
  Field to write to in packet or temp.
- len: number
  Number of bytes to read.
- Optionalopts: NotTemp<string>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:163
ascii(name: keyof U, len: number, opts: HasTemp<string>): this
Store some number of bytes, interpreted as an ASCII string.
Parameters
- name: keyof U
  Field to write to in packet or temp.
- len: number
  Number of bytes to read.
- opts: HasTemp<string>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:168

bits

bits(
    desc: {
        convert?(value: number | boolean, name: string): void;
        from: keyof T;
        to: keyof T;
    } & StartFinish,
): this
Copy some of the bits from one existing field to another. Does not work for fields larger than 53 bits. For fields larger than 32 bits, use bigints, as returned from u64(). Should only be applied to unsigned from fields. Bits are numbered with 0 on the right, MSB on the left. Start and finish can be in either order.
Parameters
- desc: {
      convert?(value: number | boolean, name: string): void;
      from: keyof T;
      to: keyof T;
  } & StartFinish
  Description of bits to capture.
Returns this
- Defined in packet.ts:466
bits(
    desc: {
        convert?(value: number | boolean, name: string): void;
        fromTemp: keyof U;
        to: keyof T;
    } & StartFinish,
): this
Copy some of the bits from one existing field to another. Does not work for fields larger than 53 bits. For fields larger than 32 bits, use bigints, as returned from u64(). Should only be applied to unsigned from fields. Bits are numbered with 0 on the right, MSB on the left. Start and finish can be in either order.
Parameters
- desc: {
      convert?(value: number | boolean, name: string): void;
      fromTemp: keyof U;
      to: keyof T;
  } & StartFinish
  Description of bits to capture.
Returns this
- Defined in packet.ts:471
bits(
    desc: {
        convert?(value: number | boolean, name: string): void;
        from: keyof T;
        toTemp: keyof U;
    } & StartFinish,
): this
Copy some of the bits from one existing field to another. Does not work for fields larger than 53 bits. For fields larger than 32 bits, use bigints, as returned from u64(). Should only be applied to unsigned from fields. Bits are numbered with 0 on the right, MSB on the left. Start and finish can be in either order.
Parameters
- desc: {
      convert?(value: number | boolean, name: string): void;
      from: keyof T;
      toTemp: keyof U;
  } & StartFinish
  Description of bits to capture.
Returns this
- Defined in packet.ts:476
bits(
    desc: {
        convert?(value: number | boolean, name: string): void;
        fromTemp: keyof U;
        toTemp: keyof U;
    } & StartFinish,
): this
Copy some of the bits from one existing field to another. Does not work for fields larger than 53 bits. For fields larger than 32 bits, use bigints, as returned from u64(). Should only be applied to unsigned from fields. Bits are numbered with 0 on the right, MSB on the left. Start and finish can be in either order.
Parameters
- desc: {
      convert?(value: number | boolean, name: string): void;
      fromTemp: keyof U;
      toTemp: keyof U;
  } & StartFinish
  Description of bits to capture.
Returns this
- Defined in packet.ts:481

bytes

bytes(
    name: keyof T,
    len: number,
    opts?: NotTemp<Uint8Array<ArrayBufferLike>>,
): this
Store some number of bytes.
Parameters
- name: keyof T
  Field to write to in packet or temp.
- len: number
  Number of bytes to read.
- Optionalopts: NotTemp<Uint8Array<ArrayBufferLike>>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:145
bytes(
    name: keyof U,
    len: number,
    opts: HasTemp<Uint8Array<ArrayBufferLike>>,
): this
Store some number of bytes.
Parameters
- name: keyof U
  Field to write to in packet or temp.
- len: number
  Number of bytes to read.
- opts: HasTemp<Uint8Array<ArrayBufferLike>>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:146

complete

complete(): this
Assert that all of the data been read. Throws an exception if extra data.

Returns this
This, for chaining.
- Defined in packet.ts:116

constant

constant(name: keyof T, val: FieldType, opts?: NotTemp<FieldType>): this
Store a constant to the packet.
Parameters
- name: keyof T
  Field to write to in packet or temp.
- val: FieldType
  Any constant value.
- Optionalopts: NotTemp<FieldType>
  Read options.
Returns this
- Defined in packet.ts:531
constant(name: keyof U, val: FieldType, opts: HasTemp<FieldType>): this
Store a constant to the packet.
Parameters
- name: keyof U
  Field to write to in packet or temp.
- val: FieldType
  Any constant value.
- opts: HasTemp<FieldType>
  Read options.
Returns this
- Defined in packet.ts:536

f16

f16(name: keyof T, opts?: NotTemp<number>): this
Store a 16 bit float.
Parameters
- name: keyof T
  Field to write to in packet or temp.
- Optionalopts: NotTemp<number>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:338
f16(name: keyof U, opts: HasTemp<number>): this
Store a 16 bit float.
Parameters
- name: keyof U
  Field to write to in packet or temp.
- opts: HasTemp<number>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:339

f32

f32(name: keyof T, opts?: NotTemp<number>): this
Store a 32 bit float.
Parameters
- name: keyof T
  Field to write to in packet or temp.
- Optionalopts: NotTemp<number>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:354
f32(name: keyof U, opts: HasTemp<number>): this
Store a 32 bit float.
Parameters
- name: keyof U
  Field to write to in packet or temp.
- opts: HasTemp<number>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:355

f64

f64(name: keyof T, opts?: NotTemp<number>): this
Store a 64 bit float.
Parameters
- name: keyof T
  Field to write to in packet or temp.
- Optionalopts: NotTemp<number>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:370
f64(name: keyof U, opts: HasTemp<number>): this
Store a 64 bit float.
Parameters
- name: keyof U
  Field to write to in packet or temp.
- opts: HasTemp<number>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:371

i16

i16(name: keyof T, opts?: NotTemp<number>): this
Store a signed 16 bit integer.
Parameters
- name: keyof T
  Field to write to in packet or temp.
- Optionalopts: NotTemp<number>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:290
i16(name: keyof U, opts: HasTemp<number>): this
Store a signed 16 bit integer.
Parameters
- name: keyof U
  Field to write to in packet or temp.
- opts: HasTemp<number>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:291

i32

i32(name: keyof T, opts?: NotTemp<number>): this
Store a signed 32 bit integer.
Parameters
- name: keyof T
  Field to write to in packet or temp.
- Optionalopts: NotTemp<number>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:306
i32(name: keyof U, opts: HasTemp<number>): this
Store a signed 32 bit integer.
Parameters
- name: keyof U
  Field to write to in packet or temp.
- opts: HasTemp<number>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:307

i64

i64(name: keyof T, opts?: NotTemp<bigint>): this
Store a signed 64 bit integer as a bigint.
Parameters
- name: keyof T
  Field to write to in packet or temp.
- Optionalopts: NotTemp<bigint>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:322
i64(name: keyof U, opts: HasTemp<bigint>): this
Store a signed 64 bit integer as a bigint.
Parameters
- name: keyof U
  Field to write to in packet or temp.
- opts: HasTemp<bigint>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:323

i8

i8(name: keyof T, opts?: NotTemp<number>): this
Store a signed 8 bit integer.
Parameters
- name: keyof T
  Field to write to in packet or temp.
- Optionalopts: NotTemp<number>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:274
i8(name: keyof U, opts: HasTemp<number>): this
Store a signed 8 bit integer.
Parameters
- name: keyof U
  Field to write to in packet or temp.
- opts: HasTemp<number>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:275

maybe

maybe(doIt: boolean, fn: () => void): this
Convenience function to perhaps execute a read.
Parameters
- doIt: boolean
  Should fn be executed?
- fn: () => void
  Run if doIt is true.
Returns this
This, for chaining.
- Defined in packet.ts:416

reset

reset(): this
Reset all packet data, temp data, and return reader to the start. Mostly useful for testing.

Returns this
This, for chaining.
- Defined in packet.ts:103

times

times(
    name: keyof T,
    num: number,
    fn: (n: number) => FieldType,
    opts?: NotTemp<FieldType[]>,
): this
Convenience function to repeat reading a given number of times.
Parameters
- name: keyof T
  Packet field name to read into, as an array.
- num: number
  Number of times to call fn.
- fn: (n: number) => FieldType
  Function that reads.
- Optionalopts: NotTemp<FieldType[]>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:388
times(
    name: keyof U,
    num: number,
    fn: (n: number) => FieldType,
    opts: HasTemp<FieldType[]>,
): this
Convenience function to repeat reading a given number of times.
Parameters
- name: keyof U
  Packet field name to read into, as an array.
- num: number
  Number of times to call fn.
- fn: (n: number) => FieldType
  Function that reads.
- opts: HasTemp<FieldType[]>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:394

u16

u16(name: keyof T, opts?: NotTemp<number>): this
Store an unsigned 16 bit integer.
Parameters
- name: keyof T
  Field to write to in packet or temp.
- Optionalopts: NotTemp<number>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:226
u16(name: keyof U, opts: HasTemp<number>): this
Store an unsigned 16 bit integer.
Parameters
- name: keyof U
  Field to write to in packet or temp.
- opts: HasTemp<number>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:227

u32

u32(name: keyof T, opts?: NotTemp<number>): this
Store an unsigned 32 bit integer.
Parameters
- name: keyof T
  Field to write to in packet or temp.
- Optionalopts: NotTemp<number>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:242
u32(name: keyof U, opts: HasTemp<number>): this
Store an unsigned 32 bit integer.
Parameters
- name: keyof U
  Field to write to in packet or temp.
- opts: HasTemp<number>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:243

u64

u64(name: keyof T, opts?: NotTemp<bigint>): this
Store an unsigned 64 bit integer as a bigint.
Parameters
- name: keyof T
  Field to write to in packet or temp.
- Optionalopts: NotTemp<bigint>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:258
u64(name: keyof U, opts: HasTemp<bigint>): this
Store an unsigned 64 bit integer as a bigint.
Parameters
- name: keyof U
  Field to write to in packet or temp.
- opts: HasTemp<bigint>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:259

u8

u8(name: keyof T, opts?: NotTemp<number>): this
Store an unsigned 8 bit integer.
Parameters
- name: keyof T
  Field to write to in packet or temp.
- Optionalopts: NotTemp<number>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:210
u8(name: keyof U, opts: HasTemp<number>): this
Store an unsigned 8 bit integer.
Parameters
- name: keyof U
  Field to write to in packet or temp.
- opts: HasTemp<number>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:211

unused

unused(name: keyof T, opts?: NotTemp<Uint8Array<ArrayBufferLike>>): this
Store all of the data that has yet to be read.
Parameters
- name: keyof T
  Field to write to in packet or temp.
- Optionalopts: NotTemp<Uint8Array<ArrayBufferLike>>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:128
unused(name: keyof U, opts: HasTemp<Uint8Array<ArrayBufferLike>>): this
Store all of the data that has yet to be read.
Parameters
- name: keyof U
  Field to write to in packet or temp.
- opts: HasTemp<Uint8Array<ArrayBufferLike>>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:129

utf8

utf8(name: keyof T, len: number, opts?: NotTemp<string>): this
Store some number of bytes, interpreted as a UTF8 string.
Parameters
- name: keyof T
  Field to write to in packet or temp.
- len: number
  Number of bytes to read.
- Optionalopts: NotTemp<string>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:189
utf8(name: keyof U, len: number, opts: HasTemp<string>): this
Store some number of bytes, interpreted as a UTF8 string.
Parameters
- name: keyof U
  Field to write to in packet or temp.
- len: number
  Number of bytes to read.
- opts: HasTemp<string>
  Read options.
Returns this
This, for chaining.
- Defined in packet.ts:190

while

while<V>(
    name: keyof T,
    keepGoing: (iteration: number, r: DataViewReader) => boolean,
    read: (iteration: number, r: DataViewReader) => V,
    opts?: NotTemp<V[]>,
): this
Repeat the given read until a condition fails.
Type Parameters
- V
Parameters
- name: keyof T
  Packet field name to read into, as an array.
- keepGoing: (iteration: number, r: DataViewReader) => boolean
  While this function returns true, keep calling read.
- read: (iteration: number, r: DataViewReader) => V
  The value returned from this function is added to the array.
- Optionalopts: NotTemp<V[]>
  Read options.
Returns this
- Defined in packet.ts:431
while<V>(
    name: keyof U,
    keepGoing: (iteration: number, r: DataViewReader) => boolean,
    read: (iteration: number, r: DataViewReader) => V,
    opts: HasTemp<V[]>,
): this
Repeat the given read until a condition fails.
Type Parameters
- V
Parameters
- name: keyof U
  Packet field name to read into, as an array.
- keepGoing: (iteration: number, r: DataViewReader) => boolean
  While this function returns true, keep calling read.
- read: (iteration: number, r: DataViewReader) => V
  The value returned from this function is added to the array.
- opts: HasTemp<V[]>
  Read options.
Returns this
- Defined in packet.ts:437

Class Packet<T, U>

Type Parameters

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Packet<T, U>

Accessors

left

Returns number

offset

Returns number

packet

Returns T

temp

Returns U

Methods

ascii

Parameters

Returns this

Parameters

Returns this

bits

Parameters

Returns this

Parameters

Returns this

Parameters

Returns this

Parameters

Returns this

bytes

Parameters

Returns this

Parameters

Returns this

complete

Returns this

constant

Parameters

Returns this

Parameters

Returns this

f16

Parameters

Returns this

Parameters

Returns this

f32

Parameters

Returns this

Parameters

Returns this

f64

Parameters

Returns this

Parameters

Returns this

i16

Parameters

Returns this

Parameters

Returns this

i32

Parameters

Returns this

Parameters

Returns this

i64

Parameters

Returns this

Parameters

Returns this

i8

Parameters

Returns this