mongoose 9.2.2 → 9.2.4

package/lib/drivers/node-mongodb-native/collection.js

@@ -82,7 +82,7 @@ NativeCollection.prototype._getCollection = function _getCollection() {
 
 /**
  * Copy the collection methods and make them subject to queues
- * @param {Number|String} I
+ * @param {number|string} I
  * @api private
  */
 
@@ -278,7 +278,7 @@ NativeCollection.prototype.$format = function(arg, color, shell) {
 
 /**
  * Debug print helper
- * @param {Any} representation
+ * @param {any} representation
  * @api private
  */
 

package/lib/drivers/node-mongodb-native/connection.js

@@ -52,9 +52,9 @@ Object.setPrototypeOf(NativeConnection.prototype, MongooseConnection.prototype);
  *
  * **Note:** Calling `close()` on a `useDb()` connection will close the base connection as well.
  *
- * @param {String} name The database name
- * @param {Object} [options]
- * @param {Boolean} [options.useCache=false] If true, cache results so calling `useDb()` multiple times with the same name only creates 1 connection object.
+ * @param {string} name The database name
+ * @param {object} [options]
+ * @param {boolean} [options.useCache=false] If true, cache results so calling `useDb()` multiple times with the same name only creates 1 connection object.
  * @return {Connection} New Connection Object
  * @api public
  */
@@ -130,7 +130,7 @@ NativeConnection.prototype.useDb = function(name, options) {
  * Runs a [db-level aggregate()](https://www.mongodb.com/docs/manual/reference/method/db.aggregate/) on this connection's underlying `db`
  *
  * @param {Array} pipeline
- * @param {Object} [options]
+ * @param {object} [options]
  */
 
 NativeConnection.prototype.aggregate = function aggregate(pipeline, options) {
@@ -155,7 +155,7 @@ NativeConnection.prototype.aggregate = function aggregate(pipeline, options) {
  *
  * @method removeDb
  * @memberOf Connection
- * @param {String} name The database name
+ * @param {string} name The database name
  * @return {Connection} this
  */
 
@@ -178,7 +178,7 @@ NativeConnection.prototype.removeDb = function removeDb(name) {
 /**
  * Closes the connection
  *
- * @param {Boolean} [force]
+ * @param {boolean} [force]
  * @return {Connection} this
  * @api private
  */
@@ -211,7 +211,7 @@ NativeConnection.prototype.doClose = async function doClose(force) {
 /**
  * Implementation of `listDatabases()` for MongoDB driver
  *
- * @return Promise
+ * @return {Promise}
  * @api public
  */
 
@@ -354,7 +354,7 @@ NativeConnection.prototype.createClient = async function createClient(uri, optio
  * a schemaMap and/or an encryptedFieldsMap for the connection, combining all models
  * into a single schemaMap and encryptedFields map.
  *
- * @returns the generated schemaMap and encryptedFieldsMap
+ * @returns {object} the generated schemaMap and encryptedFieldsMap
   */
 NativeConnection.prototype._buildEncryptionSchemas = function() {
   const qeMappings = {};

package/lib/error/cast.js

@@ -10,8 +10,8 @@ const util = require('util');
 /**
  * Casting Error constructor.
  *
- * @param {String} type
- * @param {String} value
+ * @param {string} type
+ * @param {string} value
  * @inherits MongooseError
  * @api private
  */

package/lib/error/createCollectionsError.js

@@ -5,8 +5,8 @@ const MongooseError = require('./mongooseError');
 /**
  * createCollections Error constructor
  *
- * @param {String} message
- * @param {String} errorsMap
+ * @param {string} message
+ * @param {string} errorsMap
  * @inherits MongooseError
  * @api private
  */

package/lib/error/divergentArray.js

@@ -9,7 +9,7 @@ const MongooseError = require('./mongooseError');
 
 /**
  * DivergentArrayError constructor.
- * @param {Array<String>} paths
+ * @param {string[]} paths
  * @api private
  */
 

package/lib/error/eachAsyncMultiError.js

@@ -17,7 +17,7 @@ const MongooseError = require('./mongooseError');
 
 class EachAsyncMultiError extends MongooseError {
   /**
-   * @param {String} connectionString
+   * @param {string} connectionString
    */
   constructor(errors) {
     let preview = errors.map(e => e.message).join(', ');

package/lib/error/index.js

@@ -13,7 +13,7 @@
  *     err instanceof mongoose.Error.ValidationError; // true
  *
  * @constructor Error
- * @param {String} msg Error message
+ * @param {string} msg Error message
  * @inherits Error https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error
  */
 
@@ -39,7 +39,7 @@ const MongooseError = require('./mongooseError');
  * - `VersionError`: Thrown when the [document is out of sync](https://mongoosejs.com/docs/guide.html#versionKey)
  *
  * @api public
- * @property {String} name
+ * @property {string} name
  * @memberOf Error
  * @instance
  */

package/lib/error/invalidSchemaOption.js

@@ -9,7 +9,7 @@ const MongooseError = require('./mongooseError');
 
 /**
  * InvalidSchemaOption Error constructor.
- * @param {String} name
+ * @param {string} name
  * @api private
  */
 

package/lib/error/missingSchema.js

@@ -9,7 +9,7 @@ const MongooseError = require('./mongooseError');
 
 /**
  * MissingSchema Error constructor.
- * @param {String} name
+ * @param {string} name
  * @api private
  */
 

package/lib/error/objectParameter.js

@@ -10,9 +10,9 @@ const MongooseError = require('./mongooseError');
  * Constructor for errors that happen when a parameter that's expected to be
  * an object isn't an object
  *
- * @param {Any} value
- * @param {String} paramName
- * @param {String} fnName
+ * @param {any} value
+ * @param {string} paramName
+ * @param {string} fnName
  * @api private
  */
 

package/lib/error/overwriteModel.js

@@ -9,7 +9,7 @@ const MongooseError = require('./mongooseError');
 
 /**
  * OverwriteModel Error constructor.
- * @param {String} name
+ * @param {string} name
  * @api private
  */
 

package/lib/error/setOptionError.js

@@ -40,8 +40,8 @@ class SetOptionError extends MongooseError {
 
   /**
   * add message
-  * @param {String} key
-  * @param {String|Error} error
+  * @param {string} key
+  * @param {string|Error} error
   * @api private
   */
   addError(key, error) {
@@ -87,7 +87,7 @@ Object.defineProperty(SetOptionError.prototype, 'name', {
 class SetOptionInnerError extends MongooseError {
   /**
    * Error for the "errors" array in "SetOptionError" with consistent message
-   * @param {String} key
+   * @param {string} key
    */
   constructor(key) {
     super(`"${key}" is not a valid option to set`);

package/lib/error/strict.js

@@ -9,9 +9,9 @@ const MongooseError = require('./mongooseError');
 /**
  * Strict mode error constructor
  *
- * @param {String} path
- * @param {String} [msg]
- * @param {Boolean} [immutable]
+ * @param {string} path
+ * @param {string} [msg]
+ * @param {boolean} [immutable]
  * @inherits MongooseError
  * @api private
  */

package/lib/error/strictPopulate.js

@@ -9,8 +9,8 @@ const MongooseError = require('./mongooseError');
 /**
  * Strict mode error constructor
  *
- * @param {String} path
- * @param {String} [msg]
+ * @param {string} path
+ * @param {string} [msg]
  * @inherits MongooseError
  * @api private
  */

package/lib/error/syncIndexes.js

@@ -9,8 +9,8 @@ const MongooseError = require('./mongooseError');
 /**
  * SyncIndexes Error constructor.
  *
- * @param {String} message
- * @param {String} errorsMap
+ * @param {string} message
+ * @param {string} errorsMap
  * @inherits MongooseError
  * @api private
  */

package/lib/error/validation.js

@@ -46,8 +46,8 @@ class ValidationError extends MongooseError {
 
   /**
   * add message
-  * @param {String} path
-  * @param {String|Error} error
+  * @param {string} path
+  * @param {string|Error} error
   * @api private
   */
   addError(path, error) {

package/lib/error/validator.js

@@ -9,7 +9,7 @@ const MongooseError = require('./mongooseError');
 /**
  * Schema validator error
  *
- * @param {Object} properties
+ * @param {object} properties
  * @param {Document} doc
  * @api private
  */

package/lib/error/version.js

@@ -10,8 +10,8 @@ const MongooseError = require('./mongooseError');
  * Version Error constructor.
  *
  * @param {Document} doc
- * @param {Number} currentVersion
- * @param {Array<String>} modifiedPaths
+ * @param {number} currentVersion
+ * @param {string[]} modifiedPaths
  * @api private
  */
 

package/lib/helpers/buildMiddlewareFilter.js

@@ -10,8 +10,8 @@ const isBuiltInMiddleware = hook => hook.fn[symbols.builtInMiddleware];
 /**
  * Builds a filter for kareem's execPre/execPost based on middleware options.
  *
- * @param {Object} options - Options object that may contain `middleware` setting
- * @param {String} phase - Either 'pre' or 'post'
+ * @param {object} options - Options object that may contain `middleware` setting
+ * @param {string} phase - Either 'pre' or 'post'
  * @returns {Function|null} - null runs all middleware, isBuiltInMiddleware skips user middleware
  */
 function buildMiddlewareFilter(options, phase) {

package/lib/helpers/clone.js

@@ -23,10 +23,10 @@ const Binary = BSON.Binary;
  *
  * Functions and primitives are never cloned.
  *
- * @param {Object} obj the object to clone
- * @param {Object} options
- * @param {Boolean} isArrayChild true if cloning immediately underneath an array. Special case for minimize.
- * @return {Object} the cloned object
+ * @param {object} obj the object to clone
+ * @param {object} options
+ * @param {boolean} isArrayChild true if cloning immediately underneath an array. Special case for minimize.
+ * @return {object} the cloned object
  * @api private
  */
 

package/lib/helpers/createJSONSchemaTypeDefinition.js

@@ -3,10 +3,10 @@
 /**
  * Handles creating `{ type: 'object' }` vs `{ bsonType: 'object' }` vs `{ bsonType: ['object', 'null'] }`
  *
- * @param {String} type
- * @param {String} bsonType
- * @param {Boolean} useBsonType
- * @param {Boolean} isRequired
+ * @param {string} type
+ * @param {string} bsonType
+ * @param {boolean} useBsonType
+ * @param {boolean} isRequired
  */
 
 module.exports = function createJSONSchemaTypeArray(type, bsonType, useBsonType, isRequired) {

package/lib/helpers/cursor/eachAsync.js

@@ -14,9 +14,9 @@ const immediate = require('../immediate');
  *
  * @param {Function} next the thunk to call to get the next document
  * @param {Function} fn
- * @param {Object} options
- * @param {Number} [options.batchSize=null] if set, Mongoose will call `fn` with an array of at most `batchSize` documents, instead of a single document
- * @param {Number} [options.parallel=1] maximum number of `fn` calls that Mongoose will run in parallel
+ * @param {object} options
+ * @param {number} [options.batchSize=null] if set, Mongoose will call `fn` with an array of at most `batchSize` documents, instead of a single document
+ * @param {number} [options.parallel=1] maximum number of `fn` calls that Mongoose will run in parallel
  * @param {AbortSignal} [options.signal] allow cancelling this eachAsync(). Once the abort signal is fired, `eachAsync()` will immediately fulfill the returned promise (or call the callback) and not fetch any more documents.
  * @return {Promise}
  * @api public

package/lib/helpers/discriminator/getDiscriminatorByValue.js

@@ -5,7 +5,7 @@ const areDiscriminatorValuesEqual = require('./areDiscriminatorValuesEqual');
 /**
  * returns discriminator by discriminatorMapping.value
  *
- * @param {Object} discriminators
+ * @param {object} discriminators
  * @param {string} value
  * @api private
  */

package/lib/helpers/discriminator/mergeDiscriminatorSchema.js

@@ -8,9 +8,9 @@ const isObject = require('../../helpers/isObject');
 /**
  * Merges `from` into `to` without overwriting existing properties.
  *
- * @param {Object} to
- * @param {Object} from
- * @param {String} [path]
+ * @param {object} to
+ * @param {object} from
+ * @param {string} [path]
  * @api private
  */
 

package/lib/helpers/document/applyTimestamps.js

@@ -10,9 +10,9 @@ module.exports = applyTimestamps;
  * Apply a given schema's timestamps to the given POJO
  *
  * @param {Schema} schema
- * @param {Object} obj
- * @param {Object} [options]
- * @param {Boolean} [options.isUpdate=false] if true, treat this as an update: just set updatedAt, skip setting createdAt. If false, set both createdAt and updatedAt
+ * @param {object} obj
+ * @param {object} [options]
+ * @param {boolean} [options.isUpdate=false] if true, treat this as an update: just set updatedAt, skip setting createdAt. If false, set both createdAt and updatedAt
  * @param {Function} [options.currentTime] if set, Mongoose will call this function to get the current time.
  */
 
@@ -29,9 +29,9 @@ function applyTimestamps(schema, obj, options) {
  * Apply timestamps to any subdocuments
  *
  * @param {Schema} schema subdocument schema
- * @param {Object} res subdocument
- * @param {Object} [options]
- * @param {Boolean} [options.isUpdate=false] if true, treat this as an update: just set updatedAt, skip setting createdAt. If false, set both createdAt and updatedAt
+ * @param {object} res subdocument
+ * @param {object} [options]
+ * @param {boolean} [options.isUpdate=false] if true, treat this as an update: just set updatedAt, skip setting createdAt. If false, set both createdAt and updatedAt
  * @param {Function} [options.currentTime] if set, Mongoose will call this function to get the current time.
  */
 
@@ -55,9 +55,9 @@ function applyTimestampsToChildren(schema, res, options) {
  * Apply timestamps to a given document. Does not apply timestamps to subdocuments: use `applyTimestampsToChildren` instead
  *
  * @param {Schema} schema
- * @param {Object} obj
- * @param {Object} [options]
- * @param {Boolean} [options.isUpdate=false] if true, treat this as an update: just set updatedAt, skip setting createdAt. If false, set both createdAt and updatedAt
+ * @param {object} obj
+ * @param {object} [options]
+ * @param {boolean} [options.isUpdate=false] if true, treat this as an update: just set updatedAt, skip setting createdAt. If false, set both createdAt and updatedAt
  * @param {Function} [options.currentTime] if set, Mongoose will call this function to get the current time.
  */
 

package/lib/helpers/document/applyVirtuals.js

@@ -9,8 +9,8 @@ module.exports = applyVirtuals;
  * Apply a given schema's virtuals to a given POJO
  *
  * @param {Schema} schema
- * @param {Object} obj
- * @param {Array<string>} [virtuals] optional whitelist of virtuals to apply
+ * @param {object} obj
+ * @param {string[]} [virtuals] optional whitelist of virtuals to apply
  * @returns
  */
 
@@ -42,8 +42,8 @@ function applyVirtuals(schema, obj, virtuals) {
  * Apply virtuals to any subdocuments
  *
  * @param {Schema} schema subdocument schema
- * @param {Object} res subdocument
- * @param {Array<String>} [virtuals] optional whitelist of virtuals to apply
+ * @param {object} res subdocument
+ * @param {string[]} [virtuals] optional whitelist of virtuals to apply
  */
 
 function applyVirtualsToChildren(schema, res, virtuals) {
@@ -86,8 +86,8 @@ function applyVirtualsToChildren(schema, res, virtuals) {
  * Apply virtuals to a given document. Does not apply virtuals to subdocuments: use `applyVirtualsToChildren` instead
  *
  * @param {Schema} schema
- * @param {Object} doc
- * @param {Array<String>} [virtuals] optional whitelist of virtuals to apply
+ * @param {object} doc
+ * @param {string[]} [virtuals] optional whitelist of virtuals to apply
  * @returns
  */
 

package/lib/helpers/document/compile.js

@@ -31,10 +31,10 @@ const noDottedPathGetOptions = Object.freeze({
 
 /**
  * Compiles schemas.
- * @param {Object} tree
- * @param {Any} proto
- * @param {String} prefix
- * @param {Object} options
+ * @param {object} tree
+ * @param {any} proto
+ * @param {string} prefix
+ * @param {object} options
  * @api private
  */
 
@@ -56,12 +56,12 @@ function compile(tree, proto, prefix, options) {
 
 /**
  * Defines the accessor named prop on the incoming prototype.
- * @param {Object} options
- * @param {String} options.prop
- * @param {Boolean} options.subprops
- * @param {Any} options.prototype
- * @param {String} [options.prefix]
- * @param {Object} options.options
+ * @param {object} options
+ * @param {string} options.prop
+ * @param {boolean} options.subprops
+ * @param {any} options.prototype
+ * @param {string} [options.prefix]
+ * @param {object} options.options
  * @api private
  */
 

package/lib/helpers/document/getDeepestSubdocumentForPath.js

@@ -6,9 +6,9 @@
  * document.
  *
  * @param {Document} doc
- * @param {String[]} parts
+ * @param {string[]} parts
  * @param {Schema} schema
- * @returns Document
+ * @returns {Document}
  */
 
 module.exports = function getDeepestSubdocumentForPath(doc, parts, schema) {

package/lib/helpers/document/getEmbeddedDiscriminatorPath.js

@@ -8,8 +8,8 @@ const getSchemaDiscriminatorByValue = require('../discriminator/getSchemaDiscrim
  * determine path type without knowing the embedded discriminator key.
  *
  * @param {Document} doc
- * @param {String|String[]} path
- * @param {Object} [options]
+ * @param {string|string[]} path
+ * @param {object} [options]
  * @api private
  */
 

package/lib/helpers/indexes/isIndexEqual.js

@@ -6,9 +6,9 @@ const utils = require('../../utils');
  * Given a Mongoose index definition (key + options objects) and a MongoDB server
  * index definition, determine if the two indexes are equal.
  *
- * @param {Object} schemaIndexKeysObject the Mongoose index spec
- * @param {Object} options the Mongoose index definition's options
- * @param {Object} dbIndex the index in MongoDB as returned by `listIndexes()`
+ * @param {object} schemaIndexKeysObject the Mongoose index spec
+ * @param {object} options the Mongoose index definition's options
+ * @param {object} dbIndex the index in MongoDB as returned by `listIndexes()`
  * @api private
  */
 

package/lib/helpers/indexes/isIndexSpecEqual.js

@@ -8,9 +8,9 @@
  *     isIndexSpecEqual({ a: 1, b: 1 }, { b: 1, a: 1 }); // false
  *     isIndexSpecEqual({ a: 1, b: -1 }, { a: 1, b: 1 }); // false
  *
- * @param {Object} spec1 The first index specification to compare.
- * @param {Object} spec2 The second index specification to compare.
- * @returns {Boolean} Returns true if the index specifications are equal, otherwise returns false.
+ * @param {object} spec1 The first index specification to compare.
+ * @param {object} spec2 The second index specification to compare.
+ * @returns {boolean} Returns true if the index specifications are equal, otherwise returns false.
  */
 
 module.exports = function isIndexSpecEqual(spec1, spec2) {

package/lib/helpers/isMongooseObject.js

@@ -6,7 +6,7 @@ const isMongooseArray = require('../types/array/isMongooseArray').isMongooseArra
  *
  * This is for compatibility with libs like Date.js which do foolish things to Natives.
  *
- * @param {Any} v
+ * @param {any} v
  * @api private
  */
 

package/lib/helpers/isObject.js

@@ -3,9 +3,9 @@
 /**
  * Determines if `arg` is an object.
  *
- * @param {Object|Array|String|Function|RegExp|any} arg
+ * @param {object|Array|string|Function|RegExp|any} arg
  * @api private
- * @return {Boolean}
+ * @return {boolean}
  */
 
 module.exports = function(arg) {

package/lib/helpers/isSimpleValidator.js

@@ -3,9 +3,9 @@
 /**
  * Determines if `arg` is a flat object.
  *
- * @param {Object|Array|String|Function|RegExp|any} arg
+ * @param {object|Array|string|Function|RegExp|any} arg
  * @api private
- * @return {Boolean}
+ * @return {boolean}
  */
 
 module.exports = function isSimpleValidator(obj) {

package/lib/helpers/minimize.js

@@ -7,8 +7,8 @@ module.exports = minimize;
 /**
  * Minimizes an object, removing undefined values and empty objects
  *
- * @param {Object} object to minimize
- * @return {Object|undefined}
+ * @param {object} object to minimize
+ * @return {object|undefined}
  * @api private
  */
 

package/lib/helpers/model/applyHooks.js

@@ -32,7 +32,7 @@ const alreadyHookedFunctions = new Set(applyHooks.middlewareFunctions.flatMap(fn
  *
  * @param {Model} model
  * @param {Schema} schema
- * @param {Object} options
+ * @param {object} options
  * @api private
  */
 

package/lib/helpers/model/castBulkWrite.js

@@ -15,8 +15,8 @@ const setDefaultsOnInsert = require('../setDefaultsOnInsert');
  * Given a model and a bulkWrite op, return a thunk that handles casting and
  * validating the individual op.
  * @param {Model} originalModel
- * @param {Object} op
- * @param {Object} [options]
+ * @param {object} op
+ * @param {object} [options]
  * @api private
  */
 

package/lib/helpers/pluralize.js

@@ -76,7 +76,7 @@ const uncountables = exports.uncountables;
  * Pluralize function.
  *
  * @author TJ Holowaychuk (extracted from _ext.js_)
- * @param {String} string to pluralize
+ * @param {string} string to pluralize
  * @api private
  */
 

package/lib/helpers/populate/assignRawDocsToIdStructure.js

@@ -26,8 +26,8 @@ const kHasArray = Symbol('mongoose#assignRawDocsToIdStructure#hasArray');
  * @param {Array} rawIds
  * @param {Array} resultDocs
  * @param {Array} resultOrder
- * @param {Object} options
- * @param {Boolean} recursed
+ * @param {object} options
+ * @param {boolean} recursed
  * @api private
  */
 

package/lib/helpers/populate/assignVals.js

@@ -256,11 +256,11 @@ function numDocs(v) {
  * background:
  * _ids are left in the query even when user excludes them so
  * that population mapping can occur.
- * @param {Any} val
- * @param {Object} assignmentOpts
- * @param {Object} populateOptions
+ * @param {any} val
+ * @param {object} assignmentOpts
+ * @param {object} populateOptions
  * @param {Function} [populateOptions.transform]
- * @param {Boolean} allIds
+ * @param {boolean} allIds
  * @api private
  */
 
@@ -327,7 +327,7 @@ function valueFilter(val, assignmentOpts, populateOptions, allIds) {
 /**
  * Remove _id from `subdoc` if user specified "lean" query option
  * @param {Document} subdoc
- * @param {Object} assignmentOpts
+ * @param {object} assignmentOpts
  * @api private
  */
 
@@ -344,7 +344,7 @@ function maybeRemoveId(subdoc, assignmentOpts) {
 /**
  * Determine if `obj` is something we can set a populated path to. Can be a
  * document, a lean document, or an array/map that contains docs.
- * @param {Any} obj
+ * @param {any} obj
  * @api private
  */