@softvisio/msgpack v3.4.7

:information_source: Please, see the full project documentation here:https://softvisio-node.github.io/msgpack/

Introduction

Fork of the notepack.io with improvements:

• Code optimizations.
• Streaming decoder.
• {Date} encoded with the standard msgpack protocol extension (breaking change).
• {BigInt} type support.

Install

npm install @softvisio/msgpack

Usage

import * as msgpack from "@softvisio/msgpack";

const buffer = msgpack.encode( [ new Date() ] );

const data = msgpack.decode( buffer );

msgpack.encode( data, encoding? )

• data {any} Data structire to encode.
• encoding? {string} Return string in the specified encoding.
• Returns: {Buffer|string} Encoded data. Returns {string} if encoding parameter is provided.

msgpack.decode( data, encoding? )

• data {Buffer|ArrayBuffer|Uint8Array|string} Data to decode.
• encoding? {string} String encoding if data parameter is {string}.
• Returns: {any} Decoded data.

Throws error if unable to decode message.

msgpack.decodeStream( data, offset )

• data {Buffer|ArrayBuffer|Uint8Array|string} Data to decode.
• offset? {integer} Offset of the message start in the passed data. Default: 0.
• Returns: {Object}:
  • value {any} Decoded data.
  • offset {integer} Offset of the decoded message end in the passed data.

Returns {undefined} if message is incomplete.

Throws error if unable to decode message.

Custom extensions

Specification https://github.com/msgpack/msgpack/blob/master/spec.md.