Neurotic and Probably Misinformed
    Have ideas to improve npm?Join in the discussion! »

    bser
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/bser package

    2.1.1 • Public • Published

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

    Install

    npm i bser

    DownloadsWeekly Downloads

    9,521,857

    Version

    2.1.1

    License

    Apache-2.0

    Unpacked Size

    18 kB

    Total Files

    4

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar