Skip to content

Commit 20f764c

Browse files
KagamiChanmbroadst
authored andcommitted
fix(readme): clarify documentation about deserialize methods
1 parent 080323b commit 20f764c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

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

128128
#### BSON.deserializeStream
129129

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

148148
## FAQ
149149

0 commit comments

Comments
 (0)