Universal Binary JSON packer/unpacker for Node.js
JavaScript Makefile Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc
lib
test
.gitignore
.jshintignore
.jshintrc
.travis.yml
CHANGELOG.markdown
DEVELOPMENT.markdown
LICENSE
Makefile
README.markdown
gh_pages.sh
package.json

README.markdown

Node-UBJSON

NPM version BS CS


Universal Binary JSON packer/unpacker for Node.js.

Check out the Github repo for the source code. Visit module site for API docs and examples. Extra information available in wiki.

Installation

You can install this module via npm:

$> npm install ubjson

Also you can build latest source code from repository, see below.

Usage example

// Preallocate buffer
var buffer = new Buffer(1024);

// Synchronous pack
var offset = UBJSON.packToBufferSync(jsonObject, buffer);
buffer = buffer.slice(0, offset);

// Asynchronous pack
UBJSON.packToBuffer({"key": "value"}, buffer, function (error, offset) {
  if (error) {
    throw error;
  }

  buffer = buffer.slice(0, offset);

  // Asynchronous unpack
  UBJSON.unpackBuffer(buffer, function (error, value) {
    if (error) {
      throw error;
    }

    done();
  });
});

Full API documentation.

Contributing

To contribute any patches, simply fork this repository using GitHub and send a pull request to me. Thanks!

All information about development use and contribution is placed in the DEVELOPMENT file.

License

MIT license. See license text in file LICENSE.