Skip to content

Commit

Permalink
fix(readme): clarify documentation about deserialize methods
Browse files Browse the repository at this point in the history
  • Loading branch information
KagamiChan authored and mbroadst committed Jun 6, 2018
1 parent 080323b commit 20f764c
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ The BSON `deserialize` method takes a Node.js Buffer and an optional options obj
* @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.
* @return {Object} returns the deserialized Javascript Object.

#### BSON.deserializeStream

Expand All @@ -143,7 +143,7 @@ The BSON `deserializeStream` method takes a Node.js Buffer, `startIndex` and all
* @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.
* @return {Number} returns the next index in the buffer after deserialization **x** numbers of documents.

## FAQ

Expand Down

0 comments on commit 20f764c

Please sign in to comment.