From 7770c30e8b6d78ae054b83afce11c1ea33e06178 Mon Sep 17 00:00:00 2001 From: jannyHou Date: Tue, 19 Nov 2019 17:38:32 -0500 Subject: [PATCH] doc: add few comment --- docker.setup.js | 2 +- lib/cloudant.js | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docker.setup.js b/docker.setup.js index 9af33bcc..9f467550 100644 --- a/docker.setup.js +++ b/docker.setup.js @@ -19,7 +19,7 @@ const async = require('async'); const docker = new require('dockerode')(); const http = require('http'); const ms = require('ms'); -const fs = require('fs-extra'); +const fs = require('fs'); process.env.CLOUDANT_DATABASE = 'testdb'; process.env.CLOUDANT_PASSWORD = 'pass'; diff --git a/lib/cloudant.js b/lib/cloudant.js index e71b6531..3cbd15b4 100644 --- a/lib/cloudant.js +++ b/lib/cloudant.js @@ -135,12 +135,15 @@ Cloudant.prototype.ping = function(cb) { }; /** - * Apply find queries function + * Apply find queries function. + * This function will perform a partitionedFind if `partitionKey` + * is provided in the options or from the query(to be supported). * * @param {Object} mo The selected model * @param {Object} query The query to filter * @param {Object[]} docs Model document/data * @param {Object} include Include filter + * @param {Object} options Options for find method, like `partitionKey` * @callback {Function} cb The callback function */ Cloudant.prototype._findRecursive = function(