Module basic module

module msgpack

msgpack is a more lightweight data exchange format than JSON. It can serialize JSON objects into binary data to achieve faster and more efficient data exchange.

The msgpack encoding and decoding module is referenced as

1 2
var encoding = require('encoding'); var msgpack = encoding.msgpack;


var msgpack = require('msgpack');

The msgpack module provides two main methods for message processing: encode and decode.

  • encode:Write the given data in msgpack encoding Value Message.encode(Value data). Sample code:

    1 2 3 4 5 6
    var msgpack = require('msgpack'); var data = { foo: 'bar' }; var buffer = msgpack.encode(data);

    This method first needs to pass in the data that needs to be written, and then saves the data as binary data in msgpack format and returns it. The encoding process is very fast.

  • decode: Parse the data in the message in msgpack encoding Value Message.decode(). Sample code:

    1 2 3 4
    var msgpack = require('msgpack'); var data = msgpack.encode({foo: 'bar'}); var unpackedData = msgpack.decode(data);

    At this time, the data being parsed will be ajsonObject {foo: 'bar'}can be used directly.

The msgpack module is a relatively efficient way to serialize and deserialize message data. It can send message data to the other party in binary form and avoids the efficiency problems of character combination and restoration during text data transmission. This module It is very suitable for use in scenarios where large amounts of message data need to be processed.

static function


Encode variables in msgpack format

static Buffer msgpack.encode(Value data);

Call parameters:

  • data: Value, the variable to encode

Return results:

  • Buffer, returns encoded binary data


Decode a string into a variable using msgpack

static Value msgpack.decode(Buffer data);

Call parameters:

  • data:Buffer, the binary data to be decoded

Return results:

  • Value, returns the decoded variable