docs(options): options default to null

Change [param=null] to [param] to avoid
setting default value to null for optional
parameters.

Fixes NODE-1385

lib/admin.js

@@ -64,9 +64,9 @@ function Admin(db, topology, promiseLibrary) {
  * Execute a command
  * @method
  * @param {object} command The command hash
- * @param {object} [options=null] Optional settings.
- * @param {(ReadPreference|string)} [options.readPreference=null] The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
- * @param {number} [options.maxTimeMS=null] Number of milliseconds to wait before aborting the query.
+ * @param {object} [options] Optional settings.
+ * @param {(ReadPreference|string)} [options.readPreference] The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
+ * @param {number} [options.maxTimeMS] Number of milliseconds to wait before aborting the query.
  * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
@@ -168,13 +168,13 @@ Admin.prototype.ping = function(options, callback) {
  * @method
  * @param {string} username The username.
  * @param {string} password The password.
- * @param {object} [options=null] Optional settings.
- * @param {(number|string)} [options.w=null] The write concern.
- * @param {number} [options.wtimeout=null] The write concern timeout.
+ * @param {object} [options] Optional settings.
+ * @param {(number|string)} [options.w] The write concern.
+ * @param {number} [options.wtimeout] The write concern timeout.
  * @param {boolean} [options.j=false] Specify a journal write concern.
  * @param {boolean} [options.fsync=false] Specify a file sync write concern.
- * @param {object} [options.customData=null] Custom data associated with the user (only Mongodb 2.6 or higher)
- * @param {object[]} [options.roles=null] Roles associated with the created user (only Mongodb 2.6 or higher)
+ * @param {object} [options.customData] Custom data associated with the user (only Mongodb 2.6 or higher)
+ * @param {object[]} [options.roles] Roles associated with the created user (only Mongodb 2.6 or higher)
  * @param {ClientSession} [options.session] optional session to use for this operation
  * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
@@ -203,9 +203,9 @@ Admin.prototype.addUser = function(username, password, options, callback) {
  * Remove a user from a database
  * @method
  * @param {string} username The username.
- * @param {object} [options=null] Optional settings.
- * @param {(number|string)} [options.w=null] The write concern.
- * @param {number} [options.wtimeout=null] The write concern timeout.
+ * @param {object} [options] Optional settings.
+ * @param {(number|string)} [options.w] The write concern.
+ * @param {number} [options.wtimeout] The write concern timeout.
  * @param {boolean} [options.j=false] Specify a journal write concern.
  * @param {boolean} [options.fsync=false] Specify a file sync write concern.
  * @param {ClientSession} [options.session] optional session to use for this operation
@@ -235,7 +235,7 @@ Admin.prototype.removeUser = function(username, options, callback) {
  * Validate an existing collection
  *
  * @param {string} collectionName The name of the collection to validate.
- * @param {object} [options=null] Optional settings.
+ * @param {object} [options] Optional settings.
  * @param {ClientSession} [options.session] optional session to use for this operation
  * @param {Admin~resultCallback} [callback] The command result callback.
  * @return {Promise} returns Promise if no callback passed
@@ -255,7 +255,7 @@ Admin.prototype.validateCollection = function(collectionName, options, callback)
 /**
  * List the available databases
  *
- * @param {object} [options=null] Optional settings.
+ * @param {object} [options] Optional settings.
  * @param {boolean} [options.nameOnly=false] Whether the command should return only db names, or names and size info.
  * @param {ClientSession} [options.session] optional session to use for this operation
  * @param {Admin~resultCallback} [callback] The command result callback.

lib/bulk/ordered.js

@@ -577,9 +577,9 @@ var executeCommands = function(self, options, callback) {
  * Execute the ordered bulk operation
  *
  * @method
- * @param {object} [options=null] Optional settings.
- * @param {(number|string)} [options.w=null] The write concern.
- * @param {number} [options.wtimeout=null] The write concern timeout.
+ * @param {object} [options] Optional settings.
+ * @param {(number|string)} [options.w] The write concern.
+ * @param {number} [options.wtimeout] The write concern timeout.
  * @param {boolean} [options.j=false] Specify a journal write concern.
  * @param {boolean} [options.fsync=false] Specify a file sync write concern.
  * @param {OrderedBulkOperation~resultCallback} [callback] The result callback

lib/bulk/unordered.js

@@ -588,9 +588,9 @@ var executeBatches = function(self, options, callback) {
  * Execute the ordered bulk operation
  *
  * @method
- * @param {object} [options=null] Optional settings.
- * @param {(number|string)} [options.w=null] The write concern.
- * @param {number} [options.wtimeout=null] The write concern timeout.
+ * @param {object} [options] Optional settings.
+ * @param {(number|string)} [options.w] The write concern.
+ * @param {number} [options.wtimeout] The write concern timeout.
  * @param {boolean} [options.j=false] Specify a journal write concern.
  * @param {boolean} [options.fsync=false] Specify a file sync write concern.
  * @param {UnorderedBulkOperation~resultCallback} [callback] The result callback

lib/change_stream.js

@@ -195,8 +195,8 @@ class ChangeStream extends EventEmitter {
   /**
    * Return a modified Readable stream including a possible transform method.
    * @method
-   * @param {object} [options=null] Optional settings.
-   * @param {function} [options.transform=null] A transformation method applied to each document emitted by the stream.
+   * @param {object} [options] Optional settings.
+   * @param {function} [options.transform] A transformation method applied to each document emitted by the stream.
    * @return {Cursor}
    */
   stream(options) {