mongoose 9.2.3 → 9.2.4

package/lib/schemaType.js

@@ -33,9 +33,9 @@ const setOptionsForDefaults = { _skipMarkModified: true };
  *     const schema = new Schema({ name: String });
  *     schema.path('name') instanceof SchemaType; // true
  *
- * @param {String} path
+ * @param {string} path
  * @param {SchemaTypeOptions} [options] See [SchemaTypeOptions docs](https://mongoosejs.com/docs/api/schematypeoptions.html)
- * @param {String} [instance]
+ * @param {string} [instance]
  * @param {Schema} [parentSchema]
  * @api public
  */
@@ -215,9 +215,9 @@ SchemaType.prototype.validators;
 SchemaType.prototype.isRequired;
 
 /**
- * Split the current dottet path into segments
+ * Split the current dotted path into segments
  *
- * @return {String[]|undefined}
+ * @return {string[]|undefined}
  * @api private
  */
 
@@ -310,9 +310,9 @@ SchemaType.prototype.castFunction = function castFunction(caster, message) {
 /**
  * The function that Mongoose calls to cast arbitrary values to this SchemaType.
  *
- * @param {Object} value value to cast
+ * @param {object} value value to cast
  * @param {Document} doc document that triggers the casting
- * @param {Boolean} init
+ * @param {boolean} init
  * @api public
  */
 
@@ -328,8 +328,8 @@ SchemaType.prototype.cast = function cast() {
  *     // Make all strings be trimmed by default
  *     mongoose.SchemaTypes.String.set('trim', true);
  *
- * @param {String} option The name of the option you'd like to set (e.g. trim, lowercase, etc...)
- * @param {Any} value The value of the option you'd like to set.
+ * @param {string} option The name of the option you'd like to set (e.g. trim, lowercase, etc...)
+ * @param {any} value The value of the option you'd like to set.
  * @return {void}
  * @static
  * @memberOf SchemaType
@@ -404,7 +404,7 @@ SchemaType.get = function(getter) {
  *     console.log(m2.mixed); // { added: 1 }
  *
  * @param {Function|any} val The default value to set
- * @return {Any|undefined} Returns the set default value.
+ * @return {any|undefined} Returns the set default value.
  * @api public
  */
 
@@ -443,7 +443,7 @@ SchemaType.prototype.default = function(val) {
  *     s.path('my.date').index({ expires: 60 });
  *     s.path('my.path').index({ unique: true, sparse: true });
  *
- * @param {Object|Boolean|String|Number} options
+ * @param {object|boolean|string|number} options
  * @return {SchemaType} this
  * @api public
  */
@@ -480,8 +480,8 @@ SchemaType.prototype.index = function(options) {
  * Note that the above syntax does **not** work for `bulkWrite()` or `insertMany()`. `bulkWrite()` and `insertMany()`
  * will still throw MongoDB's default `E11000 duplicate key error` message.
  *
- * @param {Boolean} value
- * @param {String} [message]
+ * @param {boolean} value
+ * @param {string} [message]
  * @return {SchemaType} this
  * @api public
  */
@@ -520,7 +520,7 @@ SchemaType.prototype.unique = function unique(value, message) {
  *      const s = new Schema({ name : { type: String, text : true } })
  *      s.path('name').index({ text : true });
  *
- * @param {Boolean} bool
+ * @param {boolean} bool
  * @return {SchemaType} this
  * @api public
  */
@@ -557,7 +557,7 @@ SchemaType.prototype.text = function(bool) {
  *     const s = new Schema({ name: { type: String, sparse: true } });
  *     s.path('name').index({ sparse: true });
  *
- * @param {Boolean} bool
+ * @param {boolean} bool
  * @return {SchemaType} this
  * @api public
  */
@@ -622,7 +622,7 @@ SchemaType.prototype.sparse = function(bool) {
  *     // the property is immutable.
  *     Model.updateOne({}, { name: 'test2' }, { strict: false });
  *
- * @param {Boolean} bool
+ * @param {boolean} bool
  * @return {SchemaType} this
  * @see isNew https://mongoosejs.com/docs/api/document.html#Document.prototype.isNew()
  * @api public
@@ -847,8 +847,8 @@ SchemaType.prototype.get = function(fn) {
  * Adds multiple validators for this document path.
  * Calls `validate()` for every element in validators.
  *
- * @param {Array<RegExp|Function|Object>} validators
- * @returns this
+ * @param {(RegExp|Function|object)[]} validators
+ * @returns {SchemaType}
  */
 
 SchemaType.prototype.validateAll = function(validators) {
@@ -955,12 +955,12 @@ SchemaType.prototype.validateAll = function(validators) {
  *     // registering an error listener on the Model lets us handle errors more locally
  *     Product.on('error', handleError);
  *
- * @param {RegExp|Function|Object} obj validator function, or hash describing options
+ * @param {RegExp|Function|object} obj validator function, or hash describing options
  * @param {Function} [obj.validator] validator function. If the validator function returns `undefined` or a truthy value, validation succeeds. If it returns [falsy](https://masteringjs.io/tutorials/fundamentals/falsy) (except `undefined`) or throws an error, validation fails.
- * @param {String|Function} [obj.message] optional error message. If function, should return the error message as a string
- * @param {Boolean} [obj.propsParameter=false] If true, Mongoose will pass the validator properties object (with the `validator` function, `message`, etc.) as the 2nd arg to the validator function. This is disabled by default because many validators [rely on positional args](https://github.com/chriso/validator.js#validators), so turning this on may cause unpredictable behavior in external validators.
- * @param {String|Function} [errorMsg] optional error message. If function, should return the error message as a string
- * @param {String} [type] optional validator type
+ * @param {string|Function} [obj.message] optional error message. If function, should return the error message as a string
+ * @param {boolean} [obj.propsParameter=false] If true, Mongoose will pass the validator properties object (with the `validator` function, `message`, etc.) as the 2nd arg to the validator function. This is disabled by default because many validators [rely on positional args](https://github.com/chriso/validator.js#validators), so turning this on may cause unpredictable behavior in external validators.
+ * @param {string|Function} [errorMsg] optional error message. If function, should return the error message as a string
+ * @param {string} [type] optional validator type
  * @return {SchemaType} this
  * @api public
  */
@@ -1063,10 +1063,10 @@ SchemaType.prototype.validate = function(obj, message, type) {
  * the value is not null nor undefined). However, most built-in mongoose schema
  * types override the default `checkRequired` function:
  *
- * @param {Boolean|Function|Object} required enable/disable the validator, or function that returns required boolean, or options object
- * @param {Boolean|Function} [options.isRequired] enable/disable the validator, or function that returns required boolean
+ * @param {boolean|Function|object} required enable/disable the validator, or function that returns required boolean, or options object
+ * @param {boolean|Function} [options.isRequired] enable/disable the validator, or function that returns required boolean
  * @param {Function} [options.ErrorConstructor] custom error constructor. The constructor receives 1 parameter, an object containing the validator properties.
- * @param {String} [message] optional custom error message
+ * @param {string} [message] optional custom error message
  * @return {SchemaType} this
  * @see Customized Error Messages https://mongoosejs.com/docs/api/error.html#Error.messages
  * @see SchemaArray#checkRequired https://mongoosejs.com/docs/api/schemaarray.html#SchemaArray.prototype.checkRequired()
@@ -1170,7 +1170,7 @@ SchemaType.prototype.required = function(required, message) {
  *       user: { type: mongoose.ObjectId, ref: User }
  *     });
  *
- * @param {String|Model|Function} ref either a model name, a [Model](https://mongoosejs.com/docs/models.html), or a function that returns a model name or model.
+ * @param {string|Model|Function} ref either a model name, a [Model](https://mongoosejs.com/docs/models.html), or a function that returns a model name or model.
  * @return {SchemaType} this
  * @api public
  */
@@ -1183,9 +1183,9 @@ SchemaType.prototype.ref = function(ref) {
 /**
  * Gets the default value
  *
- * @param {Object} scope the scope which callback are executed
- * @param {Boolean} init
- * @return {Any} The Stored default value.
+ * @param {object} scope the scope which callback are executed
+ * @param {boolean} init
+ * @return {any} The Stored default value.
  * @api private
  */
 
@@ -1229,11 +1229,11 @@ SchemaType.prototype.getDefault = function(scope, init, options) {
 /**
  * Applies setters without casting
  *
- * @param {Any} value
- * @param {Any} scope
- * @param {Boolean} init
- * @param {Any} priorVal
- * @param {Object} [options]
+ * @param {any} value
+ * @param {any} scope
+ * @param {boolean} init
+ * @param {any} priorVal
+ * @param {object} [options]
  * @instance
  * @api private
  */
@@ -1263,10 +1263,10 @@ SchemaType.prototype._castNullish = function _castNullish(v) {
 /**
  * Applies setters
  *
- * @param {Object} value
- * @param {Object} scope
- * @param {Boolean} init
- * @return {Any}
+ * @param {any} value
+ * @param {object} scope
+ * @param {boolean} init
+ * @return {any}
  * @api private
  */
 
@@ -1284,9 +1284,9 @@ SchemaType.prototype.applySetters = function(value, scope, init, priorVal, optio
 /**
  * Applies getters to a value
  *
- * @param {Object} value
- * @param {Object} scope
- * @return {Any}
+ * @param {object} value
+ * @param {object} scope
+ * @return {any}
  * @api private
  */
 
@@ -1318,7 +1318,7 @@ SchemaType.prototype.applyGetters = function(value, scope) {
  *     // .. unless overridden;
  *     T.find().select('-x').exec(callback);
  *
- * @param {Boolean} val
+ * @param {boolean} val
  * @return {SchemaType} this
  * @api public
  */
@@ -1331,11 +1331,11 @@ SchemaType.prototype.select = function select(val) {
 /**
  * Performs a validation of `value` using the validators declared for this SchemaType.
  *
- * @param {Any} value
- * @param {Object} scope
- * @param {Object} [options]
- * @param {String} [options.path]
- * @return {Any} If no validators, returns the output from calling `fn`, otherwise no return
+ * @param {any} value
+ * @param {object} scope
+ * @param {object} [options]
+ * @param {string} [options.path]
+ * @return {any} If no validators, returns the output from calling `fn`, otherwise no return
  * @api public
  */
 
@@ -1447,10 +1447,10 @@ function _validate(ok, validatorProperties) {
  *
  * This method ignores the asynchronous validators.
  *
- * @param {Any} value
- * @param {Object} scope
- * @param {Object} [options]
- * @param {Object} [options.path]
+ * @param {any} value
+ * @param {object} scope
+ * @param {object} [options]
+ * @param {string} [options.path]
  * @return {MongooseError|null}
  * @api private
  */
@@ -1539,10 +1539,10 @@ SchemaType.prototype.doValidateSync = function(value, scope, options) {
  * Determines if value is a valid Reference.
  *
  * @param {SchemaType} self
- * @param {Object} value
+ * @param {object} value
  * @param {Document} doc
- * @param {Boolean} init
- * @return {Boolean}
+ * @param {boolean} init
+ * @return {boolean}
  * @api private
  */
 
@@ -1684,10 +1684,10 @@ SchemaType.prototype.$conditionalHandlers = {
 /**
  * Cast the given value with the given optional query operator.
  *
- * @param {String} [$conditional] query operator, like `$eq` or `$in`
- * @param {Any} val
+ * @param {string} [$conditional] query operator, like `$eq` or `$in`
+ * @param {any} val
  * @param {Query} context
- * @return {Any}
+ * @return {any}
  * @api private
  */
 
@@ -1740,8 +1740,8 @@ SchemaType.checkRequired = function(fn) {
 /**
  * Default check for if this path satisfies the `required` validator.
  *
- * @param {Any} val
- * @return {Boolean} `true` when the value is not `null`, `false` otherwise
+ * @param {any} val
+ * @return {boolean} `true` when the value is not `null`, `false` otherwise
  * @api private
  */
 
@@ -1806,9 +1806,9 @@ SchemaType.prototype._duplicateKeyErrorMessage = null;
 /**
  * Returns this schema type's representation in a JSON schema.
  *
- * @param [options]
- * @param [options.useBsonType=false] If true, return a representation with `bsonType` for use with MongoDB's `$jsonSchema`.
- * @returns {Object} JSON schema properties
+ * @param {object} [options]
+ * @param {boolean} [options.useBsonType=false] If true, return a representation with `bsonType` for use with MongoDB's `$jsonSchema`.
+ * @returns {object} JSON schema properties
  */
 
 SchemaType.prototype.toJSONSchema = function toJSONSchema(_options) { // eslint-disable-line no-unused-vars

package/lib/stateMachine.js

@@ -25,8 +25,7 @@ const StateMachine = module.exports = exports = function StateMachine() {
  * methods named after each state. These transition methods
  * place their path argument into the given state.
  *
- * @param {String} state
- * @param {String} [state]
+ * @param {...string} state one or more state names
  * @return {Function} subclass constructor
  * @api private
  */
@@ -126,7 +125,7 @@ StateMachine.prototype.getStatePaths = function getStatePaths(state) {
  * Checks to see if at least one path is in the states passed in via `arguments`
  * e.g., this.some('required', 'inited')
  *
- * @param {String} state that we want to check for.
+ * @param {string} state that we want to check for.
  * @api private
  */
 
@@ -145,7 +144,7 @@ StateMachine.prototype.some = function some() {
  * This function builds the functions that get assigned to `forEach` and `map`,
  * since both of those methods share a lot of the same logic.
  *
- * @param {String} iterMethod is either 'forEach' or 'map'
+ * @param {string} iterMethod is either 'forEach' or 'map'
  * @return {Function}
  * @api private
  */
@@ -180,8 +179,7 @@ StateMachine.prototype._iter = function _iter(iterMethod) {
  * this.forEach(state1, state2, fn); // iterates over all paths in state1 or state2
  * this.forEach(fn);                 // iterates over all paths in all states
  *
- * @param {String} [state]
- * @param {String} [state]
+ * @param {...string} [state] one or more state names to filter by
  * @param {Function} callback
  * @api private
  */
@@ -199,8 +197,7 @@ StateMachine.prototype.forEach = function forEach() {
  * this.forEach(state1, state2, fn); // iterates over all paths in state1 or state2
  * this.forEach(fn);                 // iterates over all paths in all states
  *
- * @param {String} [state]
- * @param {String} [state]
+ * @param {...string} [state] one or more state names to filter by
  * @param {Function} callback
  * @return {Array}
  * @api private

package/lib/types/array/index.js

@@ -20,7 +20,7 @@ const arraySchemaSymbol = require('../../helpers/symbols').arraySchemaSymbol;
  * _Values always have to be passed to the constructor to initialize, otherwise `MongooseArray#push` will mark the array as modified._
  *
  * @param {Array} values
- * @param {String} path
+ * @param {string} path
  * @param {Document} doc parent document
  * @api private
  * @inherits Array https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array

package/lib/types/array/methods/index.js

@@ -246,7 +246,7 @@ const methods = {
    * Casts a member based on this arrays schema.
    *
    * @param {any} value
-   * @return value the casted value
+   * @return {any} the casted value
    * @method _cast
    * @api private
    * @memberOf MongooseArray
@@ -291,7 +291,7 @@ const methods = {
    * Internal helper for .map()
    *
    * @api private
-   * @return {Number}
+   * @return {number}
    * @method _mapCast
    * @memberOf MongooseArray
    */
@@ -306,7 +306,7 @@ const methods = {
    * If it bubbles up from an embedded document change, then it takes the following arguments (otherwise, takes 0 arguments)
    *
    * @param {ArraySubdocument} subdoc the embedded doc that invoked this method on the Array
-   * @param {String} embeddedPath the path which changed in the subdoc
+   * @param {string} embeddedPath the path which changed in the subdoc
    * @method _markModified
    * @api private
    * @memberOf MongooseArray
@@ -500,7 +500,7 @@ const methods = {
    * Returns the number of pending atomic operations to send to the db for this array.
    *
    * @api private
-   * @return {Number}
+   * @return {number}
    * @method hasAtomics
    * @memberOf MongooseArray
    */
@@ -516,9 +516,9 @@ const methods = {
   /**
    * Return whether or not the `obj` is included in the array.
    *
-   * @param {Object} obj the item to check
-   * @param {Number} fromIndex
-   * @return {Boolean}
+   * @param {object} obj the item to check
+   * @param {number} fromIndex
+   * @return {boolean}
    * @api public
    * @method includes
    * @memberOf MongooseArray
@@ -532,9 +532,9 @@ const methods = {
   /**
    * Return the index of `obj` or `-1` if not found.
    *
-   * @param {Object} obj the item to look for
-   * @param {Number} fromIndex
-   * @return {Number}
+   * @param {object} obj the item to look for
+   * @param {number} fromIndex
+   * @return {number}
    * @api public
    * @method indexOf
    * @memberOf MongooseArray
@@ -707,7 +707,7 @@ const methods = {
    *     });
    *     doc.nums; // [1, 2, 3, 4, 5]
    *
-   * @param {...Object} [args]
+   * @param {...object} [args]
    * @api public
    * @method push
    * @memberOf MongooseArray
@@ -916,7 +916,7 @@ const methods = {
   /**
    * Returns a native js Array.
    *
-   * @param {Object} options
+   * @param {object} options
    * @return {Array}
    * @api public
    * @method toObject

package/lib/types/arraySubdocument.js

@@ -13,11 +13,11 @@ const documentArrayParent = require('../helpers/symbols').documentArrayParent;
 /**
  * A constructor.
  *
- * @param {Object} obj js object returned from the db
+ * @param {object} obj js object returned from the db
  * @param {MongooseDocumentArray} parentArr the parent array of this document
- * @param {Boolean} skipId
- * @param {Object} fields
- * @param {Number} index
+ * @param {boolean} skipId
+ * @param {object} fields
+ * @param {number} index
  * @inherits Document
  * @api private
  */
@@ -107,9 +107,9 @@ ArraySubdocument.prototype.$__removeFromParent = function() {
 /**
  * Returns the full path to this document. If optional `path` is passed, it is appended to the full path.
  *
- * @param {String} [path]
- * @param {Boolean} [skipIndex] Skip adding the array index. For example `arr.foo` instead of `arr.0.foo`.
- * @return {String}
+ * @param {string} [path]
+ * @param {boolean} [skipIndex] Skip adding the array index. For example `arr.foo` instead of `arr.0.foo`.
+ * @return {string}
  * @api private
  * @method $__fullPath
  * @memberOf ArraySubdocument
@@ -194,7 +194,7 @@ ArraySubdocument.prototype.$__setParent = function $__setParent(parent) {
  *
  * @api public
  * @method parentArray
- * @returns DocumentArray
+ * @returns {DocumentArray}
  */
 
 ArraySubdocument.prototype.parentArray = function() {

package/lib/types/buffer.js

@@ -14,8 +14,8 @@ const utils = require('../utils');
  * Values always have to be passed to the constructor to initialize.
  *
  * @param {Buffer} value
- * @param {String} encode
- * @param {Number} offset
+ * @param {string} encode
+ * @param {number} offset
  * @api private
  * @inherits Buffer https://nodejs.org/api/buffer.html
  * @see https://bit.ly/f6CnZU
@@ -121,7 +121,7 @@ MongooseBuffer.mixin = {
    *
    * `Buffer#copy` does not mark `target` as modified so you must copy from a `MongooseBuffer` for it to work as expected. This is a work around since `copy` modifies the target, not this.
    *
-   * @return {Number} The number of bytes copied.
+   * @return {number} The number of bytes copied.
    * @param {Buffer} target
    * @method copy
    * @memberOf MongooseBuffer.mixin
@@ -228,7 +228,7 @@ MongooseBuffer.mixin.toUUID = function() {
  * Determines if this buffer is equals to `other` buffer
  *
  * @param {Buffer} other
- * @return {Boolean}
+ * @return {boolean}
  * @method equals
  * @memberOf MongooseBuffer
  */

package/lib/types/documentArray/index.js

@@ -19,7 +19,7 @@ const numberRE = /^\d+$/;
  * DocumentArray constructor
  *
  * @param {Array} values
- * @param {String} path the path to this array
+ * @param {string} path the path to this array
  * @param {Document} doc parent document
  * @api private
  * @return {MongooseDocumentArray}

package/lib/types/documentArray/methods/index.js

@@ -119,7 +119,7 @@ const methods = {
    *     const embeddedDoc = m.array.id(some_id);
    *
    * @return {EmbeddedDocument|null} the subdocument or null if not found.
-   * @param {ObjectId|String|Number|Buffer} id
+   * @param {ObjectId|string|number|Buffer} id
    * @method id
    * @api public
    * @memberOf MongooseDocumentArray
@@ -185,7 +185,7 @@ const methods = {
    *
    * _Each sub-document is converted to a plain object by calling its `#toObject` method._
    *
-   * @param {Object} [options] optional options to pass to each documents `toObject` method call during conversion
+   * @param {object} [options] optional options to pass to each documents `toObject` method call during conversion
    * @return {Array}
    * @method toObject
    * @api public
@@ -213,7 +213,7 @@ const methods = {
   /**
    * Wraps [`Array#push`](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array/push) with proper change tracking.
    *
-   * @param {...Object} [args]
+   * @param {...object} [args]
    * @api public
    * @method push
    * @memberOf MongooseDocumentArray
@@ -230,7 +230,7 @@ const methods = {
   /**
    * Pulls items from the array atomically.
    *
-   * @param {...Object} [args]
+   * @param {...object} [args]
    * @api public
    * @method pull
    * @memberOf MongooseDocumentArray
@@ -287,7 +287,7 @@ const methods = {
    *
    * This is the same subdocument constructor used for casting.
    *
-   * @param {Object} obj the value to cast to this arrays SubDocument schema
+   * @param {object} obj the value to cast to this arrays SubDocument schema
    * @method create
    * @api public
    * @memberOf MongooseDocumentArray

package/lib/types/map.js

@@ -251,8 +251,8 @@ class MongooseMap extends Map {
    *
    * @api public
    * @method toJSON
-   * @param {Object} [options]
-   * @param {Boolean} [options.flattenMaps=false] set to `true` to convert the map to a POJO rather than a native JavaScript map
+   * @param {object} [options]
+   * @param {boolean} [options.flattenMaps=false] set to `true` to convert the map to a POJO rather than a native JavaScript map
    * @memberOf Map
    */
 
@@ -345,7 +345,7 @@ Object.defineProperty(MongooseMap.prototype, '$__deferredCalls', {
 /**
  * Since maps are stored as objects under the hood, keys must be strings
  * and can't contain any invalid characters
- * @param {String} key
+ * @param {string} key
  * @api private
  */
 

package/lib/types/subdocument.js

@@ -60,11 +60,11 @@ Subdocument.prototype.toBSON = function() {
  *
  * _This is a no-op. Does not actually save the doc to the db._
  *
- * @param {Object} [options]
- * @param {Boolean} [options.suppressWarning=false] If `true`, suppress the warning about calling `save()` on a subdoc.
- * @param {Boolean|Object} [options.middleware=true] set to `false` to skip all user-defined middleware
- * @param {Boolean} [options.middleware.pre=true] set to `false` to skip only pre hooks
- * @param {Boolean} [options.middleware.post=true] set to `false` to skip only post hooks
+ * @param {object} [options]
+ * @param {boolean} [options.suppressWarning=false] If `true`, suppress the warning about calling `save()` on a subdoc.
+ * @param {boolean|object} [options.middleware=true] set to `false` to skip all user-defined middleware
+ * @param {boolean} [options.middleware.pre=true] set to `false` to skip only pre hooks
+ * @param {boolean} [options.middleware.post=true] set to `false` to skip only post hooks
  * @return {Promise} resolved Promise
  * @api private
  */
@@ -85,11 +85,11 @@ Subdocument.prototype.save = async function save(options) {
 /**
  * Given a path relative to this document, return the path relative
  * to the top-level document.
- * @param {String} path
+ * @param {string} path
  * @method $__fullPath
  * @memberOf Subdocument
  * @instance
- * @returns {String}
+ * @returns {string}
  * @api private
  */
 
@@ -106,8 +106,8 @@ Subdocument.prototype.$__fullPath = function(path) {
 /**
  * Given a path relative to this document, return the path relative
  * to the parent document.
- * @param {String} p
- * @returns {String}
+ * @param {string} p
+ * @returns {string}
  * @method $__pathRelativeToParent
  * @memberOf Subdocument
  * @instance
@@ -203,7 +203,7 @@ Subdocument.prototype.isModified = function(paths, options, modifiedPaths) {
 /**
  * Marks a path as valid, removing existing validation errors.
  *
- * @param {String} path the field to mark as valid
+ * @param {string} path the field to mark as valid
  * @api private
  * @method $markValid
  * @memberOf Subdocument
@@ -360,7 +360,7 @@ Subdocument.prototype.$__removeFromParent = function() {
 /**
  * Null-out this subdoc
  *
- * @param {Object} [options]
+ * @param {object} [options]
  */
 
 Subdocument.prototype.deleteOne = function deleteOne(options) {