bser
JavaScript implementation of the BSER Binary Serialization
Last updated 9 months ago by wez .
Apache-2.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install bser 
SYNC missed versions from official npm registry.

BSER Binary Serialization

BSER is a binary serialization scheme that can be used as an alternative to JSON. BSER uses a framed encoding that makes it simpler to use to stream a sequence of encoded values.

It is intended to be used for local-IPC only and strings are represented as binary with no specific encoding; this matches the convention employed by most operating system filename storage.

For more details about the serialization scheme see Watchman's docs.

API

var bser = require('bser');

bser.loadFromBuffer

The is the synchronous decoder; given an input string or buffer, decodes a single value and returns it. Throws an error if the input is invalid.

var obj = bser.loadFromBuffer(buf);

bser.dumpToBuffer

Synchronously encodes a value as BSER.

var encoded = bser.dumpToBuffer(['hello']);
console.log(bser.loadFromBuffer(encoded)); // ['hello']

BunserBuf

The asynchronous decoder API is implemented in the BunserBuf object. You may incrementally append data to this object and it will emit the decoded values via its value event.

var bunser = new bser.BunserBuf();

bunser.on('value', function(obj) {
  console.log(obj);
});

Then in your socket data event:

bunser.append(buf);

Example

Read BSER from socket:

var bunser = new bser.BunserBuf();

bunser.on('value', function(obj) {
  console.log('data from socket', obj);
});

var socket = net.connect('/socket');

socket.on('data', function(buf) {
  bunser.append(buf);
});

Write BSER to socket:

socket.write(bser.dumpToBuffer(obj));

Current Tags

  • 2.1.1                                ...           latest (9 months ago)

7 Versions

  • 2.1.1                                ...           9 months ago
  • 2.1.0                                ...           a year ago
  • 2.0.0                                ...           3 years ago
  • 1.0.3                                ...           3 years ago
  • 1.0.2                                ...           5 years ago
  • 1.0.1                                ...           5 years ago
  • 1.0.0                                ...           5 years ago
Downloads
Today 1,820
This Week 1,820
This Month 128,154
Last Day 4,795
Last Week 80,982
Last Month 296,948
Dependencies (1)
Dev Dependencies (0)
None
Dependents (150)

Copyright 2014 - 2016 © taobao.org |