BSON parser

BSON is short for "Binary JSON," and is the binary-encoded serialization of JSON-like documents. You can learn more about it in the specification.

This browser version of the BSON parser is compiled using rollup and the current version is pre-compiled in the dist directory.

This is the default BSON parser, however, there is a C++ Node.js addon version as well that does not support the browser. It can be found at mongod-js/bson-ext.

Table of Contents

• Usage
• Bugs/Feature Requests
• Installation
• Documentation
• FAQ

Bugs / Feature Requests

Think you've found a bug? Want to see a new feature in bson? Please open a case in our issue management tool, JIRA:

1. Create an account and login: jira.mongodb.org
2. Navigate to the NODE project: jira.mongodb.org/browse/NODE
3. Click Create Issue - Please provide as much information as possible about the issue and how to reproduce it.

Bug reports in JIRA for all driver projects (i.e. NODE, PYTHON, CSHARP, JAVA) and the Core Server (i.e. SERVER) project are public.

Usage

To build a new version perform the following operations:

npm install
npm run build

Node (no bundling)

A simple example of how to use BSON in Node.js:

const BSON = require('bson');
const Long = BSON.Long;
 
// Serialize a document
const doc = { long: Long.fromNumber(100) };
const data = BSON.serialize(doc);
console.log('data:', data);
 
// Deserialize the resulting Buffer
const doc_2 = BSON.deserialize(data);
console.log('doc_2:', doc_2);

Browser (no bundling)

If you are not using a bundler like webpack, you can include dist/bson.bundle.js using a script tag. It includes polyfills for built-in node types like Buffer.

<script src="./dist/bson.bundle.js"></script>
 
<script>
  function start() {
    // Get the Long type
    const Long = BSON.Long;
 
    // Serialize a document
    const doc = { long: Long.fromNumber(100) }
    const data = BSON.serialize(doc);
    console.log('data:', data);
 
    // De serialize it again
    const doc_2 = BSON.deserialize(data);
    console.log('doc_2:', doc_2);
  }
</script> 

Using webpack

If using webpack, you can use your normal import/require syntax of your project to pull in the bson library.

ES6 Example:

import { Long, serialize, deserialize } from 'bson';
 
// Serialize a document
const doc = { long: Long.fromNumber(100) };
const data = serialize(doc);
console.log('data:', data);
 
// De serialize it again
const doc_2 = deserialize(data);
console.log('doc_2:', doc_2);

ES5 Example:

const BSON = require('bson');
const Long = BSON.Long;
 
// Serialize a document
const doc = { long: Long.fromNumber(100) };
const data = BSON.serialize(doc);
console.log('data:', data);
 
// Deserialize the resulting Buffer
const doc_2 = BSON.deserialize(data);
console.log('doc_2:', doc_2);

Depending on your settings, webpack will under the hood resolve to one of the following:

• dist/bson.browser.esm.js If your project is in the browser and using ES6 modules (Default for webworker and web targets)
• dist/bson.browser.umd.js If your project is in the browser and not using ES6 modules
• dist/bson.esm.js If your project is in Node.js and using ES6 modules (Default for node targets)
• lib/bson.js (the normal include path) If your project is in Node.js and not using ES6 modules

For more information, see this page on webpack's resolve.mainFields and the package.json for this project

Usage with Angular

Starting with Angular 6, Angular CLI removed the shim for global and other node built-in variables (original comment here). If you are using BSON with Angular, you may need to add the following shim to your polyfills.ts file:

// In polyfills.ts
(window as any).global = window;

• Original Comment by Angular CLI
• Original Source for Solution

Installation

npm install bson

Documentation

Objects

EJSON : object

Functions

setInternalBufferSize(size)

Sets the size of the internal serialization buffer.

serialize(object) ⇒ Buffer

Serialize a Javascript object.

serializeWithBufferAndIndex(object, buffer) ⇒ Number

Serialize a Javascript object using a predefined Buffer and index into the buffer, useful when pre-allocating the space for serialization.

deserialize(buffer) ⇒ Object

Deserialize data as BSON.

calculateObjectSize(object) ⇒ Number

Calculate the bson size for a passed in Javascript object.

deserializeStream(data, startIndex, numberOfDocuments, documents, docStartIndex, [options]) ⇒ Number

Deserialize stream data as BSON documents.

EJSON

• EJSON

  • .parse(text, [options])

  • .stringify(value, [replacer], [space], [options])

  • .serialize(bson, [options])

  • .deserialize(ejson, [options])

EJSON.parse(text, [options])

Parse an Extended JSON string, constructing the JavaScript value or object described by that string.

Example

const { EJSON } = require('bson');
const text = '{ "int32": { "$numberInt": "10" } }';
 
// prints { int32: { [String: '10'] _bsontype: 'Int32', value: '10' } }
console.log(EJSON.parse(text, { relaxed: false }));
 
// prints { int32: 10 }
console.log(EJSON.parse(text));

EJSON.stringify(value, [replacer], [space], [options])

Converts a BSON document to an Extended JSON string, optionally replacing values if a replacer function is specified or optionally including only the specified properties if a replacer array is specified.

Example

const { EJSON } = require('bson');
const Int32 = require('mongodb').Int32;
const doc = { int32: new Int32(10) };
 
// prints '{"int32":{"$numberInt":"10"}}'
console.log(EJSON.stringify(doc, { relaxed: false }));
 
// prints '{"int32":10}'
console.log(EJSON.stringify(doc));

EJSON.serialize(bson, [options])

Serializes an object to an Extended JSON string, and reparse it as a JavaScript object.

EJSON.deserialize(ejson, [options])

Deserializes an Extended JSON object into a plain JavaScript object with native/BSON types

setInternalBufferSize(size)

Sets the size of the internal serialization buffer.

serialize(object)

Serialize a Javascript object.

Returns: Buffer - returns the Buffer object containing the serialized object.

serializeWithBufferAndIndex(object, buffer)

Serialize a Javascript object using a predefined Buffer and index into the buffer, useful when pre-allocating the space for serialization.

Returns: Number - returns the index pointing to the last written byte in the buffer.

deserialize(buffer)

Deserialize data as BSON.

Returns: Object - returns the deserialized Javascript Object.

calculateObjectSize(object)

Calculate the bson size for a passed in Javascript object.

Returns: Number - returns the number of bytes the BSON object will take up.

deserializeStream(data, startIndex, numberOfDocuments, documents, docStartIndex, [options])

Deserialize stream data as BSON documents.

Returns: Number - returns the next index in the buffer after deserialization x numbers of documents.

FAQ

Why does undefined get converted to null?

The undefined BSON type has been deprecated for many years, so this library has dropped support for it. Use the ignoreUndefined option (for example, from the driver ) to instead remove undefined keys.

How do I add custom serialization logic?

This library looks for toBSON() functions on every path, and calls the toBSON() function to get the value to serialize.

const BSON = require('bson');
 
class CustomSerialize {
  toBSON() {
    return 42;
  }
}
 
const obj = { answer: new CustomSerialize() };
// "{ answer: 42 }"
console.log(BSON.deserialize(BSON.serialize(obj)));