mongoose 9.2.3 → 9.2.4

package/lib/schema/int32.js

@@ -13,9 +13,9 @@ const handleBitwiseOperator = require('./operators/bitwise');
 /**
  * Int32 SchemaType constructor.
  *
- * @param {String} path
- * @param {Object} options
- * @param {Object} schemaOptions
+ * @param {string} path
+ * @param {object} options
+ * @param {object} schemaOptions
  * @param {Schema} parentSchema
  * @inherits SchemaType
  * @api public
@@ -55,8 +55,8 @@ SchemaInt32._cast = castInt32;
  *     // Make all Int32 fields required by default
  *     mongoose.Schema.Types.Int32.set('required', true);
  *
- * @param {String} option The option you'd like to set the value for
- * @param {Any} value value for option
+ * @param {string} option The option you'd like to set the value for
+ * @param {any} value value for option
  * @return {undefined}
  * @function set
  * @static
@@ -161,8 +161,8 @@ SchemaInt32.checkRequired = SchemaType.checkRequired;
 /**
  * Check if the given value satisfies a required validator.
  *
- * @param {Any} value
- * @return {Boolean}
+ * @param {any} value
+ * @return {boolean}
  * @api public
  */
 
@@ -173,8 +173,8 @@ SchemaInt32.prototype.checkRequired = function(value) {
 /**
  * Casts to Int32
  *
- * @param {Object} value
- * @param {Object} model this value is optional
+ * @param {object} value
+ * @param {object} model this value is optional
  * @api private
  */
 
@@ -237,7 +237,7 @@ function handleSingle(val, context) {
 /**
  * Casts contents for queries.
  *
- * @param {String} $conditional
+ * @param {string} $conditional
  * @param {any} val
  * @api private
  */
@@ -267,9 +267,9 @@ SchemaInt32.prototype.castForQuery = function($conditional, val, context) {
 /**
  * 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
  */
 
 SchemaInt32.prototype.toJSONSchema = function toJSONSchema(options) {

package/lib/schema/map.js

@@ -16,9 +16,9 @@ class SchemaMap extends SchemaType {
   /**
    * Map SchemaType constructor.
    *
-   * @param {String} path
-   * @param {Object} options
-   * @param {Object} schemaOptions
+   * @param {string} path
+   * @param {object} options
+   * @param {object} schemaOptions
    * @param {Schema} parentSchema
    * @inherits SchemaType
    * @api public
@@ -34,8 +34,8 @@ class SchemaMap extends SchemaType {
   /**
    * Sets a default option for all Map instances.
    *
-   * @param {String} option The option you'd like to set the value for
-   * @param {Any} value value for option
+   * @param {string} option The option you'd like to set the value for
+   * @param {any} value value for option
    * @return {undefined}
    * @function set
    * @api public
@@ -48,8 +48,8 @@ class SchemaMap extends SchemaType {
   /**
    * Casts to Map
    *
-   * @param {Object} value
-   * @param {Object} model this value is optional
+   * @param {object} value
+   * @param {object} model this value is optional
    * @api private
    */
 
@@ -119,9 +119,9 @@ class SchemaMap extends SchemaType {
   /**
    * 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
    */
 
   toJSONSchema(options) {

package/lib/schema/mixed.js

@@ -12,9 +12,9 @@ const utils = require('../utils');
 /**
  * Mixed SchemaType constructor.
  *
- * @param {String} path
- * @param {Object} options
- * @param {Object} _schemaOptions
+ * @param {string} path
+ * @param {object} options
+ * @param {object} _schemaOptions
  * @param {Schema} parentSchema
  * @inherits SchemaType
  * @api public
@@ -86,8 +86,8 @@ SchemaMixed.get = SchemaType.get;
  *     const User = mongoose.model('User', new Schema({ test: mongoose.Mixed }));
  *     new User({ }).validateSync().errors.test.message; // Path `test` is required.
  *
- * @param {String} option The option you'd like to set the value for
- * @param {Any} value value for option
+ * @param {string} option The option you'd like to set the value for
+ * @param {any} value value for option
  * @return {undefined}
  * @function set
  * @static
@@ -103,7 +103,7 @@ SchemaMixed.setters = [];
  *
  * _this is a no-op_
  *
- * @param {Object} value to cast
+ * @param {object} value to cast
  * @api private
  */
 
@@ -117,7 +117,7 @@ SchemaMixed.prototype.cast = function(val) {
 /**
  * Casts contents for queries.
  *
- * @param {String} $cond
+ * @param {string} $cond
  * @param {any} [val]
  * @api private
  */
@@ -129,9 +129,9 @@ SchemaMixed.prototype.castForQuery = function($cond, val) {
 /**
  * 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
  */
 
 // eslint-disable-next-line no-unused-vars

package/lib/schema/number.js

@@ -17,9 +17,9 @@ const CastError = SchemaType.CastError;
 /**
  * Number SchemaType constructor.
  *
- * @param {String} key
- * @param {Object} options
- * @param {Object} schemaOptions
+ * @param {string} key
+ * @param {object} options
+ * @param {object} schemaOptions
  * @param {Schema} parentSchema
  * @inherits SchemaType
  * @api public
@@ -61,8 +61,8 @@ SchemaNumber.get = SchemaType.get;
  *     const Order = mongoose.model('Order', new Schema({ amount: Number }));
  *     new Order({ amount: -10 }).validateSync().errors.amount.message; // Path `amount` must be larger than 0.
  *
- * @param {String} option The option you'd like to set the value for
- * @param {Any} value value for option
+ * @param {string} option The option you'd like to set the value for
+ * @param {any} value value for option
  * @return {undefined}
  * @function set
  * @static
@@ -163,9 +163,9 @@ SchemaNumber.checkRequired = SchemaType.checkRequired;
 /**
  * Check if the given value satisfies a required validator.
  *
- * @param {Any} value
+ * @param {any} value
  * @param {Document} doc
- * @return {Boolean}
+ * @return {boolean}
  * @api public
  */
 
@@ -207,8 +207,8 @@ SchemaNumber.prototype.checkRequired = function checkRequired(value, doc) {
  *       console.log(String(err)) // ValidationError: The value of path `n` (4) is beneath the limit (10).
  *     })
  *
- * @param {Number} value minimum number
- * @param {String} [message] optional custom error message
+ * @param {number} value minimum number
+ * @param {string} [message] optional custom error message
  * @return {SchemaType} this
  * @see Customized Error Messages https://mongoosejs.com/docs/api/error.html#Error.messages
  * @api public
@@ -261,8 +261,8 @@ SchemaNumber.prototype.min = function(value, message) {
  *       console.log(String(err)) // ValidationError: The value of path `n` (4) exceeds the limit (10).
  *     })
  *
- * @param {Number} maximum number
- * @param {String} [message] optional custom error message
+ * @param {number} maximum number
+ * @param {string} [message] optional custom error message
  * @return {SchemaType} this
  * @see Customized Error Messages https://mongoosejs.com/docs/api/error.html#Error.messages
  * @api public
@@ -306,7 +306,7 @@ SchemaNumber.prototype.max = function(value, message) {
  *     await m.save(); // succeeds
  *
  * @param {Array} values allowed values
- * @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
  * @api public
@@ -381,9 +381,9 @@ SchemaNumber.prototype.enum = function(values, message) {
 /**
  * Casts to number
  *
- * @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 private
  */
 
@@ -463,7 +463,7 @@ Object.defineProperty(SchemaNumber.prototype, '$conditionalHandlers', {
 /**
  * Casts contents for queries.
  *
- * @param {String} $conditional
+ * @param {string} $conditional
  * @param {any} [value]
  * @api private
  */
@@ -493,9 +493,9 @@ SchemaNumber.prototype.castForQuery = function($conditional, val, context) {
 /**
  * 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
  */
 
 SchemaNumber.prototype.toJSONSchema = function toJSONSchema(options) {

package/lib/schema/objectId.js

@@ -19,9 +19,9 @@ let Document;
 /**
  * ObjectId SchemaType constructor.
  *
- * @param {String} key
- * @param {Object} options
- * @param {Object} schemaOptions
+ * @param {string} key
+ * @param {object} options
+ * @param {object} schemaOptions
  * @param {Schema} parentSchema
  * @inherits SchemaType
  * @api public
@@ -87,8 +87,8 @@ SchemaObjectId.get = SchemaType.get;
  *     const Order = mongoose.model('Order', new Schema({ userId: ObjectId }));
  *     new Order({ }).validateSync().errors.userId.message; // Path `userId` is required.
  *
- * @param {String} option The option you'd like to set the value for
- * @param {Any} value value for option
+ * @param {string} option The option you'd like to set the value for
+ * @param {any} value value for option
  * @return {undefined}
  * @function set
  * @static
@@ -101,7 +101,7 @@ SchemaObjectId.setters = [];
 
 /**
  * Adds an auto-generated ObjectId default if turnOn is true.
- * @param {Boolean} turnOn auto generated ObjectId defaults
+ * @param {boolean} turnOn auto generated ObjectId defaults
  * @api public
  * @return {SchemaType} this
  */
@@ -197,9 +197,9 @@ SchemaObjectId.checkRequired = SchemaType.checkRequired;
 /**
  * Check if the given value satisfies a required validator.
  *
- * @param {Any} value
+ * @param {any} value
  * @param {Document} doc
- * @return {Boolean}
+ * @return {boolean}
  * @api public
  */
 
@@ -220,9 +220,9 @@ SchemaObjectId.prototype.checkRequired = function checkRequired(value, doc) {
 /**
  * Casts to ObjectId
  *
- * @param {Object} value
- * @param {Object} doc
- * @param {Boolean} init whether this is an initialization cast
+ * @param {object} value
+ * @param {object} doc
+ * @param {boolean} init whether this is an initialization cast
  * @api private
  */
 
@@ -311,9 +311,9 @@ function resetId(v) {
 /**
  * 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
  * @api public
  */
 

package/lib/schema/operators/text.js

@@ -8,9 +8,9 @@ const castString = require('../../cast/string');
  * Casts val to an object suitable for `$text`. Throws an error if the object
  * can't be casted.
  *
- * @param {Any} val value to cast
- * @param {String} [path] path to associate with any errors that occured
- * @return {Object} casted object
+ * @param {any} val value to cast
+ * @param {string} [path] path to associate with any errors that occurred
+ * @return {object} casted object
  * @see https://www.mongodb.com/docs/manual/reference/operator/query/text/
  * @api private
  */

package/lib/schema/string.js

@@ -17,9 +17,9 @@ const CastError = SchemaType.CastError;
 /**
  * String SchemaType constructor.
  *
- * @param {String} key
- * @param {Object} options
- * @param {Object} schemaOptions
+ * @param {string} key
+ * @param {object} options
+ * @param {object} schemaOptions
  * @param {Schema} parentSchema
  * @inherits SchemaType
  * @api public
@@ -136,8 +136,8 @@ SchemaString.get = SchemaType.get;
  *     const User = mongoose.model('User', new Schema({ name: String }));
  *     new User({ name: '   John Doe   ' }).name; // 'John Doe'
  *
- * @param {String} option The option you'd like to set the value for
- * @param {Any} value value for option
+ * @param {string} option The option you'd like to set the value for
+ * @param {any} value value for option
  * @return {undefined}
  * @function set
  * @static
@@ -204,7 +204,7 @@ SchemaString.checkRequired = SchemaType.checkRequired;
  *     await m.save();
  *     // success
  *
- * @param {...String|Object} [args] enumeration values
+ * @param {...string|object} [args] enumeration values
  * @return {SchemaType} this
  * @see Customized Error Messages https://mongoosejs.com/docs/api/error.html#Error.messages
  * @see Enums in JavaScript https://masteringjs.io/tutorials/fundamentals/enum
@@ -402,8 +402,8 @@ SchemaString.prototype.trim = function(shouldTrim) {
  *       console.log(String(err)) // ValidationError: The value of path `postalCode` (`9512`) is shorter than the minimum length (5).
  *     })
  *
- * @param {Number} value minimum string length
- * @param {String} [message] optional custom error message
+ * @param {number} value minimum string length
+ * @param {string} [message] optional custom error message
  * @return {SchemaType} this
  * @see Customized Error Messages https://mongoosejs.com/docs/api/error.html#Error.messages
  * @api public
@@ -458,8 +458,8 @@ SchemaString.prototype.minLength = SchemaString.prototype.minlength;
  *       console.log(String(err)) // ValidationError: The value of path `postalCode` (`9512512345`) exceeds the maximum allowed length (9).
  *     })
  *
- * @param {Number} value maximum string length
- * @param {String} [message] optional custom error message
+ * @param {number} value maximum string length
+ * @param {string} [message] optional custom error message
  * @return {SchemaType} this
  * @see Customized Error Messages https://mongoosejs.com/docs/api/error.html#Error.messages
  * @api public
@@ -522,7 +522,7 @@ SchemaString.prototype.maxLength = SchemaString.prototype.maxlength;
  *     const s = new Schema({ name: { type: String, match: /^a/, required: true }})
  *
  * @param {RegExp} regExp regular expression to test against
- * @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
  * @api public
@@ -563,9 +563,9 @@ SchemaString.prototype.match = function match(regExp, message) {
  * has positive length. The `required` validator **will** fail for empty
  * strings.
  *
- * @param {Any} value
+ * @param {any} value
  * @param {Document} doc
- * @return {Boolean}
+ * @return {boolean}
  * @api public
  */
 
@@ -680,7 +680,7 @@ Object.defineProperty(SchemaString.prototype, '$conditionalHandlers', {
 /**
  * Casts contents for queries.
  *
- * @param {String} $conditional
+ * @param {string} $conditional
  * @param {any} [val]
  * @api private
  */
@@ -712,9 +712,9 @@ SchemaString.prototype.castForQuery = function($conditional, val, context) {
 /**
  * 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
  */
 
 SchemaString.prototype.toJSONSchema = function toJSONSchema(options) {

package/lib/schema/subdocument.js

@@ -30,8 +30,8 @@ module.exports = SchemaSubdocument;
  * Single nested subdocument SchemaType constructor.
  *
  * @param {Schema} schema
- * @param {String} path
- * @param {Object} options
+ * @param {string} path
+ * @param {object} options
  * @param {Schema} parentSchema
  * @inherits SchemaType
  * @api public
@@ -127,7 +127,7 @@ const $conditionalHandlers = { ...SchemaType.prototype.$conditionalHandlers };
  * locations for use with $geoWithin.
  * https://www.mongodb.com/docs/manual/reference/operator/query/geoWithin/
  *
- * @param {Object} val
+ * @param {object} val
  * @api private
  */
 
@@ -171,7 +171,7 @@ Object.defineProperty(SchemaSubdocument.prototype, '$conditionalHandlers', {
 /**
  * Casts contents
  *
- * @param {Object} value
+ * @param {object} value
  * @api private
  */
 
@@ -325,11 +325,11 @@ SchemaSubdocument.prototype.doValidateSync = function(value, scope, options) {
  *     const singleNestedPath = parentSchema.path('shape');
  *     singleNestedPath.discriminator('Circle', Schema({ radius: Number }));
  *
- * @param {String} name
+ * @param {string} name
  * @param {Schema} schema fields to add to the schema for instances of this sub-class
- * @param {Object|string} [options] If string, same as `options.value`.
- * @param {String} [options.value] the string stored in the `discriminatorKey` property. If not specified, Mongoose uses the `name` parameter.
- * @param {Boolean} [options.clone=true] By default, `discriminator()` clones the given `schema`. Set to `false` to skip cloning.
+ * @param {object|string} [options] If string, same as `options.value`.
+ * @param {string} [options.value] the string stored in the `discriminatorKey` property. If not specified, Mongoose uses the `name` parameter.
+ * @param {boolean} [options.clone=true] By default, `discriminator()` clones the given `schema`. Set to `false` to skip cloning.
  * @return {Function} the constructor Mongoose will use for creating instances of this discriminator model
  * @see discriminators https://mongoosejs.com/docs/discriminators.html
  * @api public
@@ -367,8 +367,8 @@ SchemaSubdocument.defaultOptions = {};
  *     // Make all subdocuments required by default.
  *     mongoose.Schema.Types.Subdocument.set('required', true);
  *
- * @param {String} option The option you'd like to set the value for
- * @param {Any} value value for option
+ * @param {string} option The option you'd like to set the value for
+ * @param {any} value value for option
  * @return {void}
  * @function set
  * @static
@@ -422,9 +422,9 @@ SchemaSubdocument.prototype.clone = function() {
 /**
  * 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
  */
 
 SchemaSubdocument.prototype.toJSONSchema = function toJSONSchema(options) {

package/lib/schema/union.js

@@ -17,9 +17,9 @@ class Union extends SchemaType {
   /**
    * Create a Union schema type.
    *
-   * @param {String} key the path in the schema for this schema type
-   * @param {Object} options SchemaType-specific options (must have 'of' as array)
-   * @param {Object} schemaOptions additional options from the schema this schematype belongs to
+   * @param {string} key the path in the schema for this schema type
+   * @param {object} options SchemaType-specific options (must have 'of' as array)
+   * @param {object} schemaOptions additional options from the schema this schematype belongs to
    * @param {Schema} parentSchema the schema this schematype belongs to
    */
   constructor(key, options, schemaOptions, parentSchema) {

package/lib/schema/uuid.js

@@ -15,8 +15,8 @@ const UUID_FORMAT = castUUID.UUID_FORMAT;
 
 /**
  * Convert binary to a uuid string
- * @param {Buffer|Binary|String} uuidBin The value to process
- * @returns {String} The completed uuid-string
+ * @param {Buffer|Binary|string} uuidBin The value to process
+ * @returns {string} The completed uuid-string
  * @api private
  */
 function binaryToString(uuidBin) {
@@ -33,9 +33,9 @@ function binaryToString(uuidBin) {
 /**
  * UUIDv1 SchemaType constructor.
  *
- * @param {String} key
- * @param {Object} options
- * @param {Object} _schemaOptions
+ * @param {string} key
+ * @param {object} options
+ * @param {object} _schemaOptions
  * @param {Schema} parentSchema
  * @inherits SchemaType
  * @api public
@@ -98,8 +98,8 @@ SchemaUUID.get = SchemaType.get;
  *     const User = mongoose.model('User', new Schema({ test: mongoose.UUID }));
  *     new User({ }).validateSync().errors.test.message; // Path `test` is required.
  *
- * @param {String} option The option you'd like to set the value for
- * @param {Any} value value for option
+ * @param {string} option The option you'd like to set the value for
+ * @param {any} value value for option
  * @return {undefined}
  * @function set
  * @static
@@ -166,8 +166,8 @@ SchemaUUID.checkRequired = SchemaType.checkRequired;
 /**
  * Check if the given value satisfies a required validator.
  *
- * @param {Any} value
- * @return {Boolean}
+ * @param {any} value
+ * @return {boolean}
  * @api public
  */
 
@@ -181,9 +181,9 @@ SchemaUUID.prototype.checkRequired = function checkRequired(value) {
 /**
  * Casts to UUID
  *
- * @param {Object} value
- * @param {Object} doc
- * @param {Boolean} init whether this is an initialization cast
+ * @param {object} value
+ * @param {object} doc
+ * @param {boolean} init whether this is an initialization cast
  * @api private
  */
 
@@ -257,7 +257,7 @@ Object.defineProperty(SchemaUUID.prototype, '$conditionalHandlers', {
 /**
  * Casts contents for queries.
  *
- * @param {String} $conditional
+ * @param {string} $conditional
  * @param {any} val
  * @api private
  */
@@ -284,9 +284,9 @@ SchemaUUID.prototype.castForQuery = function($conditional, val, context) {
 /**
  * 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
  */
 
 SchemaUUID.prototype.toJSONSchema = function toJSONSchema(options) {