Skip to content

Commit e311056

Browse files
KagamiChanmbroadst
authored andcommitted
fix(readme): clarify documentation about deserialize methods
1 parent 492670d commit e311056

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

Diff for: README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ The BSON `deserialize` method takes a Node.js Buffer and an optional options obj
121121
* @param {Object} [options.promoteValues=false] when deserializing will promote BSON values to their Node.js closest equivalent types.
122122
* @param {Object} [options.fieldsAsRaw=null] allow to specify if there what fields we wish to return as unserialized raw buffer.
123123
* @param {Object} [options.bsonRegExp=false] return BSON regular expressions as BSONRegExp instances.
124-
* @return {Number} returns the next index in the buffer after deserialization **x** numbers of documents.
124+
* @return {Object} returns the deserialized Javascript Object.
125125

126126
#### BSON.deserializeStream
127127

@@ -141,7 +141,7 @@ The BSON `deserializeStream` method takes a Node.js Buffer, `startIndex` and all
141141
* @param {Object} [options.promoteValues=false] when deserializing will promote BSON values to their Node.js closest equivalent types.
142142
* @param {Object} [options.fieldsAsRaw=null] allow to specify if there what fields we wish to return as unserialized raw buffer.
143143
* @param {Object} [options.bsonRegExp=false] return BSON regular expressions as BSONRegExp instances.
144-
* @return {Object} returns the deserialized JavaScript Object.
144+
* @return {Number} returns the next index in the buffer after deserialization **x** numbers of documents.
145145

146146
## FAQ
147147

0 commit comments

Comments
 (0)