Package Exports
- msgpack-lite
- msgpack-lite/dist/msgpack.min.js
- msgpack-lite/lib/decoder
- msgpack-lite/lib/encoder
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (msgpack-lite) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
msgpack-lite 
Fast Pure JavaScript MessagePack Encoder and Decoder
Online demo: http://kawanet.github.io/msgpack-lite/
Significantly Fast Encoding
- 5x faster than other pure JavaScript libraries! (Node.js v0.12.7)
- 50% faster than C++ node-gyp based msgpack library!
Fast Decoding
- 20% faster than other pure JavaScript libraries!
- 5% faster than C++ node-gyp based msgpack library!
Encoding and Decoding MessagePack
var msgpack = require("msgpack-lite");
// encode from JS Object to MessagePack (Buffer)
var buffer = msgpack.encode({"foo": "bar"});
// decode from MessagePack (Buffer) to JS 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 multiple objects decoded from stream
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-liteBrowser Build
Browser version msgpack.min.js is also available. 33KB minified, 10KB gziped.
<!--[if lte IE 9]>
<script src="https://cdnjs.cloudflare.com/ajax/libs/es5-shim/4.1.10/es5-shim.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/json3/3.3.2/json3.min.js"></script>
<![endif]-->
<script src="https://rawgithub.com/kawanet/msgpack-lite/master/dist/msgpack.min.js"></script>
<script>
// encode from JS Object to MessagePack (Uint8Array)
var buffer = msgpack.encode({foo: "bar"});
// decode from MessagePack (Uint8Array) to JS Object
var array = new Uint8Array([0x81, 0xA3, 0x66, 0x6F, 0x6F, 0xA3, 0x62, 0x61, 0x72]);
var data = msgpack.decode(array);
</script>Interoperability
It is tested to have basic compatibility with other Node.js MessagePack modules below:
- https://www.npmjs.com/package/msgpack (0.2.6)
- https://www.npmjs.com/package/msgpack-js (0.3.0)
- https://www.npmjs.com/package/msgpack-js-v5 (0.3.0-v5)
- https://www.npmjs.com/package/msgpack5 (3.1.0)
- https://www.npmjs.com/package/msgpack-unpack (2.1.1)
- https://github.com/msgpack/msgpack-javascript (msgpack.codec)
Speed Comparison
A benchmark tool lib/benchmark.js is available to compare encoding/decoding speed.
$ cat /etc/system-release
Amazon Linux AMI release 2015.03
$ node lib/benchmark.js -v
msgpack-lite 0.1.9
$ nvm use v0.10.40
Now using node v0.10.40
$ node lib/benchmark.js 10
operation | op / ms | op/s
-------------------------------------------------------------- | ------------------ | -----
buf = Buffer(JSON.stringify(obj)); | 228500op / 10004ms | 2284
obj = JSON.parse(buf); | 242200op / 10000ms | 2422
buf = require("msgpack").pack(obj); | 185000op / 10007ms | 1848
obj = require("msgpack").unpack(buf); | 233200op / 10001ms | 2331
buf = require("msgpack-lite").encode(obj); | 230300op / 10000ms | 2303
obj = require("msgpack-lite").decode(buf); | 188700op / 10000ms | 1887
buf = Buffer(require("msgpack-javascript").msgpack.pack(obj)); | 137100op / 10009ms | 1369
obj = require("msgpack-javascript").msgpack.unpack(buf); | 102000op / 10006ms | 1019
buf = require("msgpack-js-v5").encode(obj); | 30700op / 10027ms | 306
obj = require("msgpack-js-v5").decode(buf); | 110600op / 10007ms | 1105
buf = require("msgpack-js").encode(obj); | 30000op / 10033ms | 299
obj = require("msgpack-js").decode(buf); | 115300op / 10008ms | 1152
buf = require("msgpack5")().encode(obj); | 4500op / 10174ms | 44
obj = require("msgpack5")().decode(buf); | 18800op / 10046ms | 187
obj = require("msgpack-unpack").decode(buf); | 1700op / 10497ms | 16This runs more faster on Node.js 0.12.
$ nvm use v0.12.7
Now using node v0.12.7
$ node lib/benchmark.js 10
operation | op / ms | op/s
-------------------------------------------------------------- | ------------------ | -----
buf = Buffer(JSON.stringify(obj)); | 260700op / 10009ms | 2604
obj = JSON.parse(buf); | 255400op / 10008ms | 2551
buf = require("msgpack").pack(obj); | 157000op / 10010ms | 1568
obj = require("msgpack").unpack(buf); | 195900op / 10006ms | 1957
buf = require("msgpack-lite").encode(obj); | 256900op / 10005ms | 2567
obj = require("msgpack-lite").decode(buf); | 204100op / 10001ms | 2040
buf = Buffer(require("msgpack-javascript").msgpack.pack(obj)); | 46700op / 10022ms | 465
obj = require("msgpack-javascript").msgpack.unpack(buf); | 165900op / 10009ms | 1657
buf = require("msgpack-js-v5").encode(obj); | 41100op / 10019ms | 410
obj = require("msgpack-js-v5").decode(buf); | 142900op / 10006ms | 1428
buf = require("msgpack-js").encode(obj); | 41500op / 10001ms | 414
obj = require("msgpack-js").decode(buf); | 139700op / 10000ms | 1397
buf = require("msgpack5")().encode(obj); | 4600op / 10201ms | 45
obj = require("msgpack5")().decode(buf); | 19200op / 10010ms | 191
obj = require("msgpack-unpack").decode(buf); | 1000op / 10129ms | 9MessagePack Mapping Table
The following table shows how JavaScript objects (value) will be mapped to MessagePack formats and vice versa.
| Source Value | MessagePack Format | Value Decoded |
|---|---|---|
| null, undefined | nil format family | null |
| Boolean (true, false) | bool format family | Boolean (true, false) |
| Number (32bit int) | int format family | Number (int or double) |
| Number (64bit double) | float format family | Number (double) |
| String | str format family | String |
| Buffer | bin format family | Buffer |
| Array | array format family | Array |
| Object (plain object) | map format family | Object |
| Object (see below) | ext format family | Object (see below) |
Note that both null and undefined are mapped to nil 0xC1 type.
This means undefined value will be upgraded to null in other words.
Extension Types
The MessagePack specification allows 128 application-specific extension types. The library uses the following types to make round-trip conversion possible for JavaScript native objects.
| Type | Object | Type | Object |
|---|---|---|---|
| 0x00 | 0x10 | ||
| 0x01 | EvalError | 0x11 | Int8Array |
| 0x02 | RangeError | 0x12 | Uint8Array |
| 0x03 | ReferenceError | 0x13 | Int16Array |
| 0x04 | SyntaxError | 0x14 | Uint16Array |
| 0x05 | TypeError | 0x15 | Int32Array |
| 0x06 | URIError | 0x16 | Uint32Array |
| 0x07 | 0x17 | Float32Array | |
| 0x08 | 0x18 | Float64Array | |
| 0x09 | 0x19 | Uint8ClampedArray | |
| 0x0A | RegExp | 0x1A | ArrayBuffer |
| 0x0B | Boolean | 0x1B | |
| 0x0C | String | 0x1C | |
| 0x0D | Date | 0x1D | DataView |
| 0x0E | Error | 0x1E | |
| 0x0F | Number | 0x1F |
Other extension types are mapped to internal ExtBuffer object.
Repository
See Also
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.