Class Packr

Hierarchy

Unpackr
- Packr (view full)
  - Encoder

Index

Constructors

Methods

clearSharedData decode encode pack unpack unpackMultiple useBuffer

Properties

offset position

Constructors

constructor

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

Methods

clearSharedData

clearSharedData(): void
Returns void

decode

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

encode

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

pack

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

unpack

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

unpackMultiple

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

useBuffer

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

Properties

offset

offset: number

position

position: number