msgpack-lite

Fast Pure JavaScript MessagePack Encoder and Decoder

Encoding and Decoding

var msgpack = require("msgpack-lite");

// encode from Object to MessagePack (Buffer)
var buffer = msgpack.encode({foo: "bar"});

// decode from MessagePack (Buffer) to Object 
var data = msgpack.decode(buffer); // => {foo: "bar"}

Writing to MessagePack Stream

var fs = require("fs");
var msgpack = require("msgpack-lite");

var writeStream = fs.createWriteStream("test.msp");
var encodeStream = msgpack.createEncodeStream();
encodeStream.pipe(writeStream);

// send multiple objects to stream
encodeStream.write({foo: "bar"});
encodeStream.write({baz: "qux"});

Reading from MessagePack Stream

var fs = require("fs");
var msgpack = require("msgpack-lite");

var readStream = fs.createReadStream("test.msp");
var decodeStream = msgpack.createDecodeStream();

// show objects decoded
readStream.pipe(decodeStream).on("data", console.warn);

Command Line Interface

A CLI tool bin/msgpack converts data stream from JSON to MessagePack and vice versa.

$ echo '{"foo": "bar"}' | ./bin/msgpack -Jm | od -tx1
0000000    81  a3  66  6f  6f  a3  62  61  72

$ echo '{"foo": "bar"}' | ./bin/msgpack -Jm | ./bin/msgpack -Mj
{"foo":"bar"}

Installation

$ npm install --save msgpack-lite

Repository

• https://github.com/kawanet/msgpack-lite

Compatibility

It is tested to have basic compatibility with other MessagePack modules below:

• https://www.npmjs.com/package/msgpack
• https://www.npmjs.com/package/msgpack-js
• https://www.npmjs.com/package/msgpack-js-v5
• https://www.npmjs.com/package/msgpack5
• https://www.npmjs.com/package/msgpack-unpack

Speed Comparison

A benchmark tool bench/bench.js is available to compare encoding/decoding speed.

$ bench/bench.js 5
operation                                    | result             | op/ms
-------------------------------------------- | ------------------ | -----
buf = Buffer(JSON.stringify(obj));           | 210300op / 5001ms  | 4205
obj = JSON.parse(buf);                       | 232000op / 5000ms  | 4640
buf = require("msgpack").pack(obj);          | 181000op / 5001ms  | 3619
obj = require("msgpack").unpack(buf);        | 199400op / 5000ms  | 3988
buf = require("msgpack-lite").encode(obj);   | 109900op / 5001ms  | 2197
obj = require("msgpack-lite").decode(buf);   | 138600op / 5001ms  | 2771
buf = require("msgpack-js-v5").encode(obj);  | 29700op / 5009ms   | 592
obj = require("msgpack-js-v5").decode(buf);  | 94400op / 5001ms   | 1887
buf = require("msgpack-js").encode(obj);     | 29500op / 5014ms   | 588
obj = require("msgpack-js").decode(buf);     | 95100op / 5000ms   | 1902
buf = require("msgpack5")().encode(obj);     | 4600op / 5024ms    | 91
obj = require("msgpack5")().decode(buf);     | 18100op / 5019ms   | 360
obj = require("msgpack-unpack").decode(buf); | 1600op / 5242ms    | 30

The msgpack-lite is the fastest module on both encoding and decoding operations compared to the other pure JavaScript msgpack-* modules. Please note that node-gyp backed msgpack module is more fast still, however.

See Also

• http://msgpack.org/

License

The MIT License (MIT)

Copyright (c) 2015 Yusuke Kawasaki

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.