Class Packr

Hierarchy

Unpackr
- Packr (View Summary)
  - Encoder

Index

Constructors

Methods

clearSharedData decode encode pack unpack unpackMultiple useBuffer

Properties

offset position

Constructors

constructor

new Packr(options?: Options): Packr
Parameters
- Optionaloptions: Options
Returns Packr
Inherited from Unpackr.constructor

Methods

clearSharedData

clearSharedData(): void
Returns void

decode

decode(
messagePack: Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>,
options?: UnpackOptions,
): any
Parameters
- messagePack: Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>
- Optionaloptions: UnpackOptions
Returns any
Inherited from Unpackr.decode

encode

encode(value: any, encodeOptions?: number): Buffer
Parameters
- value: any
- OptionalencodeOptions: number
Returns Buffer

pack

pack(value: any, encodeOptions?: number): Buffer
Parameters
- value: any
- OptionalencodeOptions: number
Returns Buffer

unpack

unpack(
messagePack: Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>,
options?: UnpackOptions,
): any
Parameters
- messagePack: Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>
- Optionaloptions: UnpackOptions
Returns any
Inherited from Unpackr.unpack

unpackMultiple

unpackMultiple(
messagePack: Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>,
): any[]
Parameters
- messagePack: Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>
Returns any[]
Inherited from Unpackr.unpackMultiple
unpackMultiple(
messagePack: Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>,
forEach: (value: any, start?: number, end?: number) => any,
): void
Parameters
- messagePack: Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>
- forEach: (value: any, start?: number, end?: number) => any
Returns void
Inherited from Unpackr.unpackMultiple

useBuffer

useBuffer(buffer: Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>): void
Parameters
- buffer: Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>
Returns void

Properties

offset

offset: number

position

position: number