@types/msgpack-lite

method addExtPacker

addExtPacker: <T>(
    etype: number,
    Class: new (...args: any[]) => T,
    packer: (t: T) => Buffer | Uint8Array
) => void;

• Register a custom extension to serialize your own class instances

  Parameter etype

  an integer within the range of 0 and 127 (0x0 and 0x7F)

  Parameter Class

  the constructor of the type you wish to serialize

  Parameter packer

  a function that converts an instance of T to bytes

method addExtUnpacker

addExtUnpacker: <T>(
    etype: number,
    unpacker: (data: Buffer | Uint8Array) => T
) => void;

• Register a custom extension to deserialize your own class instances

  Parameter etype

  an integer within the range of 0 and 127 (0x0 and 0x7F)

  Parameter unpacker

  a function that converts bytes to an instance of T

property binarraybuffer

binarraybuffer?: boolean | undefined;

• It ties msgpack's bin format with ArrayBuffer object, instead of Buffer object. false

property int64

int64?: boolean | undefined;

• It decodes msgpack's int64/uint64 formats with int64-buffer object. int64-buffer is a cutom integer type with 64 bits of precision instead of the built-in IEEE-754 53 bits. See https://github.com/kawanet/int64-buffer false

property preset

preset?: boolean | undefined;

• It includes the preset extensions for JavaScript native objects.

  See Also

  • https://github.com/kawanet/msgpack-lite#extension-types false

property safe

safe?: boolean | undefined;

• It runs a validation of the value before writing it into buffer. This is the default behavior for some old browsers which do not support ArrayBuffer object. varies

property uint8array

uint8array?: boolean | undefined;

• It returns Uint8Array object when encoding, instead of Buffer object. false

property usemap

usemap?: boolean | undefined;

• It uses the global JavaScript Map type, if available, to unpack MessagePack map elements. false

property useraw

useraw?: boolean | undefined;

• It uses raw formats instead of bin and str. Set true for compatibility with msgpack's old spec.

  See Also

  • https://github.com/kawanet/msgpack-lite#compatibility-mode false

property bufferish

bufferish: any;

property offset

offset: number;

method decode

decode: (chunk: any) => void;

method end

end: (chunk: any) => void;

method fetch

fetch: () => void;

method flush

flush: () => void;

method pull

pull: () => number;

method push

push: (chunk: any) => void;

method read

read: () => number;

method reserve

reserve: (length: number) => number;

method write

write: (chunk: any) => void;

property codec

codec?: Codec | undefined;

property decoder

decoder: Decoder;

property bufferish

bufferish: any;

property maxBufferSize

maxBufferSize: number;

property minBufferSize

minBufferSize: number;

property offset

offset: number;

property start

start: number;

method encode

encode: (chunk: any) => void;

method end

end: (chunk: any) => void;

method fetch

fetch: () => void;

method flush

flush: () => void;

method pull

pull: () => number;

method push

push: (chunk: any) => void;

method read

read: () => number;

method reserve

reserve: (length: number) => number;

method send

send: (buffer: Buffer) => void;

method write

write: (chunk: any) => void;

property codec

codec?: Codec | undefined;

property encoder

encoder: Encoder;