bson - npm Package Compare versions
Comparing version 3.0.2 to 4.0.0-rc1
@@ -11,7 +11,6 @@ { | ||
| "lib", | ||
| "index.js", | ||
| "dist", | ||
| "bower.json" | ||
| ], | ||
| "version": "3.0.2", | ||
| "version": "4.0.0-rc1", | ||
| "author": "Christian Amor Kvalheim <christkv@gmail.com>", | ||
@@ -26,11 +25,18 @@ "license": "Apache-2.0", | ||
| "devDependencies": { | ||
| "benchmark": "^2.1.4", | ||
| "babel-core": "^6.26.0", | ||
| "babel-plugin-external-helpers": "^6.22.0", | ||
| "babel-preset-env": "^1.6.0", | ||
| "babel-preset-env": "^1.6.1", | ||
| "benchmark": "^2.1.4", | ||
| "chai": "^4.1.2", | ||
| "conventional-changelog-cli": "^1.3.5", | ||
| "dmd-clear": "^0.1.2", | ||
| "eslint": "^4.7.2", | ||
| "eslint-plugin-prettier": "^2.3.1", | ||
| "istanbul": "^0.4.5", | ||
| "jsdoc-to-markdown": "^4.0.1", | ||
| "karma": "^2.0.4", | ||
| "karma-chrome-launcher": "^2.2.0", | ||
| "karma-mocha": "^1.3.0", | ||
| "karma-mocha-reporter": "^2.2.5", | ||
| "karma-rollup-preprocessor": "^6.0.0", | ||
| "mocha": "^3.5.3", | ||
@@ -41,3 +47,5 @@ "prettier": "~1.12.0", | ||
| "rollup-plugin-commonjs": "^8.3.0", | ||
| "rollup-plugin-json": "^3.0.0", | ||
| "rollup-plugin-node-builtins": "^2.1.2", | ||
| "rollup-plugin-node-globals": "^1.2.1", | ||
| "rollup-plugin-node-resolve": "^3.0.3" | ||
@@ -48,7 +56,8 @@ }, | ||
| }, | ||
| "main": "./index", | ||
| "directories": { | ||
| "lib": "./lib/bson" | ||
| "main": "lib/bson.js", | ||
| "module": "dist/bson.esm.js", | ||
| "browser": { | ||
| "./index.js": "./dist/bson.browser.umd.js", | ||
| "./dist/bson.esm.js": "./dist/bson.browser.esm.js" | ||
| }, | ||
| "browser": "dist/bson.js", | ||
| "engines": { | ||
@@ -58,3 +67,6 @@ "node": ">=4.0.0" | ||
| "scripts": { | ||
| "test": "mocha ./test/node", | ||
| "docs": "jsdoc2md --heading-depth 3 --template tools/README.hbs --plugin dmd-clear --files lib/bson.js > README.md", | ||
| "test": "npm run-script test-node && npm run-script test-browser", | ||
| "test-node": "mocha ./test/node", | ||
| "test-browser": "karma start", | ||
| "build": "rollup -c", | ||
@@ -66,3 +78,7 @@ "lint": "eslint lib test", | ||
| "prepublishOnly": "npm run build" | ||
| }, | ||
| "dependencies": { | ||
| "buffer": "^5.1.0", | ||
| "long": "^4.0.0" | ||
| } | ||
| } |
195
README.md
@@ -26,13 +26,11 @@ # BSON parser | ||
| // Get the Long type | ||
| var Long = BSON.Long; | ||
| // Create a bson parser instance | ||
| var bson = new BSON(); | ||
| const Long = BSON.Long; | ||
| // Serialize document | ||
| var doc = { long: Long.fromNumber(100) } | ||
| const doc = { long: Long.fromNumber(100) } | ||
| // Serialize a document | ||
| var data = bson.serialize(doc) | ||
| const data = BSON.serialize(doc) | ||
| // De serialize it again | ||
| var doc_2 = bson.deserialize(data) | ||
| const doc_2 = BSON.deserialize(data) | ||
| } | ||
@@ -45,19 +43,14 @@ </script> | ||
| ```js | ||
| // Get BSON parser class | ||
| var BSON = require('bson') | ||
| // Get the Long type | ||
| var Long = BSON.Long; | ||
| // Create a bson parser instance | ||
| var bson = new BSON(); | ||
| const BSON = require('bson'); | ||
| const Long = BSON.Long; | ||
| // Serialize document | ||
| var doc = { long: Long.fromNumber(100) } | ||
| const doc = { long: Long.fromNumber(100) }; | ||
| // Serialize a document | ||
| var data = bson.serialize(doc) | ||
| console.log('data:', data) | ||
| const data = BSON.serialize(doc); | ||
| console.log('data:', data); | ||
| // Deserialize the resulting Buffer | ||
| var doc_2 = bson.deserialize(data) | ||
| console.log('doc_2:', doc_2) | ||
| const doc_2 = BSON.deserialize(data); | ||
| console.log('doc_2:', doc_2); | ||
| ``` | ||
@@ -69,81 +62,125 @@ | ||
| ## API | ||
| ## Documentation | ||
| ### BSON types | ||
| ### Functions | ||
| For all BSON types documentation, please refer to the documentation for the [MongoDB Node.js driver](https://github.com/mongodb/node-mongodb-native). | ||
| <dl> | ||
| <dt><a href="#setInternalBufferSize">setInternalBufferSize(size)</a></dt> | ||
| <dd><p>Sets the size of the internal serialization buffer.</p> | ||
| </dd> | ||
| <dt><a href="#serialize">serialize(object)</a> ⇒ <code>Buffer</code></dt> | ||
| <dd><p>Serialize a Javascript object.</p> | ||
| </dd> | ||
| <dt><a href="#serializeWithBufferAndIndex">serializeWithBufferAndIndex(object, buffer)</a> ⇒ <code>Number</code></dt> | ||
| <dd><p>Serialize a Javascript object using a predefined Buffer and index into the buffer, useful when pre-allocating the space for serialization.</p> | ||
| </dd> | ||
| <dt><a href="#deserialize">deserialize(buffer)</a> ⇒ <code>Object</code></dt> | ||
| <dd><p>Deserialize data as BSON.</p> | ||
| </dd> | ||
| <dt><a href="#calculateObjectSize">calculateObjectSize(object)</a> ⇒ <code>Number</code></dt> | ||
| <dd><p>Calculate the bson size for a passed in Javascript object.</p> | ||
| </dd> | ||
| <dt><a href="#deserializeStream">deserializeStream(data, startIndex, numberOfDocuments, documents, docStartIndex, [options])</a> ⇒ <code>Number</code></dt> | ||
| <dd><p>Deserialize stream data as BSON documents.</p> | ||
| </dd> | ||
| </dl> | ||
| ### BSON serialization and deserialiation | ||
| <a name="setInternalBufferSize"></a> | ||
| **`new BSON()`** - Creates a new BSON serializer/deserializer you can use to serialize and deserialize BSON. | ||
| ### setInternalBufferSize(size) | ||
| #### BSON.serialize | ||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | size | <code>number</code> | The desired size for the internal serialization buffer | | ||
| The BSON `serialize` method takes a JavaScript object and an optional options object and returns a Node.js Buffer. | ||
| Sets the size of the internal serialization buffer. | ||
| * `BSON.serialize(object, options)` | ||
| * @param {Object} object the JavaScript object to serialize. | ||
| * @param {Boolean} [options.checkKeys=false] the serializer will check if keys are valid. | ||
| * @param {Boolean} [options.serializeFunctions=false] serialize the JavaScript functions. | ||
| * @param {Boolean} [options.ignoreUndefined=true] | ||
| * @return {Buffer} returns a Buffer instance. | ||
| <a name="serialize"></a> | ||
| #### BSON.serializeWithBufferAndIndex | ||
| ### serialize(object) | ||
| The BSON `serializeWithBufferAndIndex` method takes an object, a target buffer instance and an optional options object and returns the end serialization index in the final buffer. | ||
| | Param | Type | Default | Description | | ||
| | --- | --- | --- | --- | | ||
| | object | <code>Object</code> | | the Javascript object to serialize. | | ||
| | [options.checkKeys] | <code>Boolean</code> | | the serializer will check if keys are valid. | | ||
| | [options.serializeFunctions] | <code>Boolean</code> | <code>false</code> | serialize the javascript functions **(default:false)**. | | ||
| | [options.ignoreUndefined] | <code>Boolean</code> | <code>true</code> | ignore undefined fields **(default:true)**. | | ||
| * `BSON.serializeWithBufferAndIndex(object, buffer, options)` | ||
| * @param {Object} object the JavaScript object to serialize. | ||
| * @param {Buffer} buffer the Buffer you pre-allocated to store the serialized BSON object. | ||
| * @param {Boolean} [options.checkKeys=false] the serializer will check if keys are valid. | ||
| * @param {Boolean} [options.serializeFunctions=false] serialize the JavaScript functions. | ||
| * @param {Boolean} [options.ignoreUndefined=true] ignore undefined fields. | ||
| * @param {Number} [options.index=0] the index in the buffer where we wish to start serializing into. | ||
| * @return {Number} returns the index pointing to the last written byte in the buffer. | ||
| Serialize a Javascript object. | ||
| #### BSON.calculateObjectSize | ||
| **Returns**: <code>Buffer</code> - returns the Buffer object containing the serialized object. | ||
| <a name="serializeWithBufferAndIndex"></a> | ||
| The BSON `calculateObjectSize` method takes a JavaScript object and an optional options object and returns the size of the BSON object. | ||
| ### serializeWithBufferAndIndex(object, buffer) | ||
| * `BSON.calculateObjectSize(object, options)` | ||
| * @param {Object} object the JavaScript object to serialize. | ||
| * @param {Boolean} [options.serializeFunctions=false] serialize the JavaScript functions. | ||
| * @param {Boolean} [options.ignoreUndefined=true] | ||
| * @return {Buffer} returns a Buffer instance. | ||
| | Param | Type | Default | Description | | ||
| | --- | --- | --- | --- | | ||
| | object | <code>Object</code> | | the Javascript object to serialize. | | ||
| | buffer | <code>Buffer</code> | | the Buffer you pre-allocated to store the serialized BSON object. | | ||
| | [options.checkKeys] | <code>Boolean</code> | | the serializer will check if keys are valid. | | ||
| | [options.serializeFunctions] | <code>Boolean</code> | <code>false</code> | serialize the javascript functions **(default:false)**. | | ||
| | [options.ignoreUndefined] | <code>Boolean</code> | <code>true</code> | ignore undefined fields **(default:true)**. | | ||
| | [options.index] | <code>Number</code> | | the index in the buffer where we wish to start serializing into. | | ||
| #### BSON.deserialize | ||
| Serialize a Javascript object using a predefined Buffer and index into the buffer, useful when pre-allocating the space for serialization. | ||
| The BSON `deserialize` method takes a Node.js Buffer and an optional options object and returns a deserialized JavaScript object. | ||
| **Returns**: <code>Number</code> - returns the index pointing to the last written byte in the buffer. | ||
| <a name="deserialize"></a> | ||
| * `BSON.deserialize(buffer, options)` | ||
| * @param {Object} [options.evalFunctions=false] evaluate functions in the BSON document scoped to the object deserialized. | ||
| * @param {Object} [options.cacheFunctions=false] cache evaluated functions for reuse. | ||
| * @param {Object} [options.cacheFunctionsCrc32=false] use a crc32 code for caching, otherwise use the string of the function. | ||
| * @param {Object} [options.promoteLongs=true] when deserializing a Long will fit it into a Number if it's smaller than 53 bits | ||
| * @param {Object} [options.promoteBuffers=false] when deserializing a Binary will return it as a Node.js Buffer instance. | ||
| * @param {Object} [options.promoteValues=false] when deserializing will promote BSON values to their Node.js closest equivalent types. | ||
| * @param {Object} [options.fieldsAsRaw=null] allow to specify if there what fields we wish to return as unserialized raw buffer. | ||
| * @param {Object} [options.bsonRegExp=false] return BSON regular expressions as BSONRegExp instances. | ||
| * @return {Object} returns the deserialized Javascript Object. | ||
| ### deserialize(buffer) | ||
| #### BSON.deserializeStream | ||
| | Param | Type | Default | Description | | ||
| | --- | --- | --- | --- | | ||
| | buffer | <code>Buffer</code> | | the buffer containing the serialized set of BSON documents. | | ||
| | [options.evalFunctions] | <code>Object</code> | <code>false</code> | evaluate functions in the BSON document scoped to the object deserialized. | | ||
| | [options.cacheFunctions] | <code>Object</code> | <code>false</code> | cache evaluated functions for reuse. | | ||
| | [options.cacheFunctionsCrc32] | <code>Object</code> | <code>false</code> | use a crc32 code for caching, otherwise use the string of the function. | | ||
| | [options.promoteLongs] | <code>Object</code> | <code>true</code> | when deserializing a Long will fit it into a Number if it's smaller than 53 bits | | ||
| | [options.promoteBuffers] | <code>Object</code> | <code>false</code> | when deserializing a Binary will return it as a node.js Buffer instance. | | ||
| | [options.promoteValues] | <code>Object</code> | <code>false</code> | when deserializing will promote BSON values to their Node.js closest equivalent types. | | ||
| | [options.fieldsAsRaw] | <code>Object</code> | <code></code> | allow to specify if there what fields we wish to return as unserialized raw buffer. | | ||
| | [options.bsonRegExp] | <code>Object</code> | <code>false</code> | return BSON regular expressions as BSONRegExp instances. | | ||
| | [options.allowObjectSmallerThanBufferSize] | <code>boolean</code> | <code>false</code> | allows the buffer to be larger than the parsed BSON object | | ||
| The BSON `deserializeStream` method takes a Node.js Buffer, `startIndex` and allow more control over deserialization of a Buffer containing concatenated BSON documents. | ||
| Deserialize data as BSON. | ||
| * `BSON.deserializeStream(buffer, startIndex, numberOfDocuments, documents, docStartIndex, options)` | ||
| * @param {Buffer} buffer the buffer containing the serialized set of BSON documents. | ||
| * @param {Number} startIndex the start index in the data Buffer where the deserialization is to start. | ||
| * @param {Number} numberOfDocuments number of documents to deserialize. | ||
| * @param {Array} documents an array where to store the deserialized documents. | ||
| * @param {Number} docStartIndex the index in the documents array from where to start inserting documents. | ||
| * @param {Object} [options.evalFunctions=false] evaluate functions in the BSON document scoped to the object deserialized. | ||
| * @param {Object} [options.cacheFunctions=false] cache evaluated functions for reuse. | ||
| * @param {Object} [options.cacheFunctionsCrc32=false] use a crc32 code for caching, otherwise use the string of the function. | ||
| * @param {Object} [options.promoteLongs=true] when deserializing a Long will fit it into a Number if it's smaller than 53 bits | ||
| * @param {Object} [options.promoteBuffers=false] when deserializing a Binary will return it as a Node.js Buffer instance. | ||
| * @param {Object} [options.promoteValues=false] when deserializing will promote BSON values to their Node.js closest equivalent types. | ||
| * @param {Object} [options.fieldsAsRaw=null] allow to specify if there what fields we wish to return as unserialized raw buffer. | ||
| * @param {Object} [options.bsonRegExp=false] return BSON regular expressions as BSONRegExp instances. | ||
| * @return {Number} returns the next index in the buffer after deserialization **x** numbers of documents. | ||
| **Returns**: <code>Object</code> - returns the deserialized Javascript Object. | ||
| <a name="calculateObjectSize"></a> | ||
| ### calculateObjectSize(object) | ||
| | Param | Type | Default | Description | | ||
| | --- | --- | --- | --- | | ||
| | object | <code>Object</code> | | the Javascript object to calculate the BSON byte size for. | | ||
| | [options.serializeFunctions] | <code>Boolean</code> | <code>false</code> | serialize the javascript functions **(default:false)**. | | ||
| | [options.ignoreUndefined] | <code>Boolean</code> | <code>true</code> | ignore undefined fields **(default:true)**. | | ||
| Calculate the bson size for a passed in Javascript object. | ||
| **Returns**: <code>Number</code> - returns the number of bytes the BSON object will take up. | ||
| <a name="deserializeStream"></a> | ||
| ### deserializeStream(data, startIndex, numberOfDocuments, documents, docStartIndex, [options]) | ||
| | Param | Type | Default | Description | | ||
| | --- | --- | --- | --- | | ||
| | data | <code>Buffer</code> | | the buffer containing the serialized set of BSON documents. | | ||
| | startIndex | <code>Number</code> | | the start index in the data Buffer where the deserialization is to start. | | ||
| | numberOfDocuments | <code>Number</code> | | number of documents to deserialize. | | ||
| | documents | <code>Array</code> | | an array where to store the deserialized documents. | | ||
| | docStartIndex | <code>Number</code> | | the index in the documents array from where to start inserting documents. | | ||
| | [options] | <code>Object</code> | | additional options used for the deserialization. | | ||
| | [options.evalFunctions] | <code>Object</code> | <code>false</code> | evaluate functions in the BSON document scoped to the object deserialized. | | ||
| | [options.cacheFunctions] | <code>Object</code> | <code>false</code> | cache evaluated functions for reuse. | | ||
| | [options.cacheFunctionsCrc32] | <code>Object</code> | <code>false</code> | use a crc32 code for caching, otherwise use the string of the function. | | ||
| | [options.promoteLongs] | <code>Object</code> | <code>true</code> | when deserializing a Long will fit it into a Number if it's smaller than 53 bits | | ||
| | [options.promoteBuffers] | <code>Object</code> | <code>false</code> | when deserializing a Binary will return it as a node.js Buffer instance. | | ||
| | [options.promoteValues] | <code>Object</code> | <code>false</code> | when deserializing will promote BSON values to their Node.js closest equivalent types. | | ||
| | [options.fieldsAsRaw] | <code>Object</code> | <code></code> | allow to specify if there what fields we wish to return as unserialized raw buffer. | | ||
| | [options.bsonRegExp] | <code>Object</code> | <code>false</code> | return BSON regular expressions as BSONRegExp instances. | | ||
| Deserialize stream data as BSON documents. | ||
| **Returns**: <code>Number</code> - returns the next index in the buffer after deserialization **x** numbers of documents. | ||
| ## FAQ | ||
@@ -160,3 +197,3 @@ | ||
| ```javascript | ||
| var bson = new BSON(); | ||
| const BSON = require('bson'); | ||
@@ -171,3 +208,3 @@ class CustomSerialize { | ||
| // "{ answer: 42 }" | ||
| console.log(bson.deserialize(bson.serialize(obj))); | ||
| console.log(BSON.deserialize(BSON.serialize(obj))); | ||
| ``` |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Deprecated
MaintenanceThe maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by98.04%
829162
- Number of package files
- increased by14.29%
32
- Lines of code
- increased by85.56%
21488
- Number of medium maintenance alerts
- decreased by-100%
0
- Number of lines in readme file
- increased by21.89%
206
Worsened metrics
- Dependency count
- increased byInfinity%
2
- Dev dependency count
- increased by56.25%
25
- Number of low quality alerts
- increased by100%
2
- Number of medium supply chain risk alerts
- increased by200%
9
Dependency changes
+ Addedbuffer@^5.1.0
+ Addedlong@^4.0.0
+ Addedbase64-js@1.5.1(transitive)
+ Addedbuffer@5.7.1(transitive)
+ Addedieee754@1.2.1(transitive)
+ Addedlong@4.0.0(transitive)