From 20f764c191975af4b282557a78b23ebce261f812 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=81=8B=E3=81=8C=E3=81=BF?= Date: Wed, 6 Jun 2018 21:32:03 +0800 Subject: [PATCH] fix(readme): clarify documentation about deserialize methods --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8098e3c5..06883410 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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