Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inDemoInstall

bser

Package Overview
Dependencies
1
Maintainers
3
Versions
7
Issues
File Explorer

Advanced tools

bser

JavaScript implementation of the BSER Binary Serialization

    2.1.1latest
    Github

Version published
Maintainers
3
Weekly downloads
14,255,474
decreased by-17.71%

Weekly downloads

Readme

Source

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));

Keywords

FAQs

What is bser?

JavaScript implementation of the BSER Binary Serialization

Is bser popular?

The npm package bser receives a total of 11,375,490 weekly downloads. As such, bser popularity was classified as popular.

Is bser well maintained?

We found that bser demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.It has 3 open source maintainers collaborating on the project.

Last updated on 22 Oct 2019

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket[email protected]

Product

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc