mongoose 9.2.2 → 9.2.4

package/lib/helpers/populate/createPopulateQueryFilter.js

@@ -60,7 +60,7 @@ module.exports = function createPopulateQueryFilter(ids, _match, _foreignField,
  * to avoid cast errors (gh-7706)
  * @param {Array} ids
  * @param {SchemaType} foreignSchemaType
- * @param {Boolean} [skipInvalidIds]
+ * @param {boolean} [skipInvalidIds]
  * @api private
  */
 
@@ -82,7 +82,7 @@ function _filterInvalidIds(ids, foreignSchemaType, skipInvalidIds) {
 /**
  * Format `mod.match` given that it may be an array that we need to $or if
  * the client has multiple docs with match functions
- * @param {Array|Any} match
+ * @param {Array|any} match
  * @api private
  */
 

package/lib/helpers/populate/getModelsMapForPopulate.js

@@ -353,12 +353,12 @@ module.exports = function getModelsMapForPopulate(model, docs, options) {
  * resolved refPath value so discriminator handling can inspect it later.
  *
  * @param {Function} refPath
- * @param {Document|Object} doc
+ * @param {Document|object} doc
  * @param {SchemaType} schema
- * @param {String} populatePath
+ * @param {string} populatePath
  * @param {Schema} modelSchema
- * @param {Object} queryProjection
- * @returns {{modelNames: String[], refPath: String|null}}
+ * @param {object} queryProjection
+ * @returns {{modelNames: string[], refPath: string|null}}
  * @private
  */
 function _getModelNamesFromFunctionRefPath(refPath, doc, schemaType, populatePath, modelSchema, queryProjection) {
@@ -453,13 +453,13 @@ function _getModelNamesFromFunctionRefPath(refPath, doc, schemaType, populatePat
  * for array subdocuments and falling back to the original populate path if
  * normalization fails.
  *
- * @param {String|Function} refPath
- * @param {Document|Object} doc
- * @param {String} populatePath
- * @param {String} indexedPath
+ * @param {string|Function} refPath
+ * @param {Document|object} doc
+ * @param {string} populatePath
+ * @param {string} indexedPath
  * @param {Schema} modelSchema
- * @param {Object} queryProjection
- * @returns {String[]}
+ * @param {object} queryProjection
+ * @returns {string[]}
  * @private
  */
 function _getModelNamesFromRefPath(refPath, doc, populatePath, indexedPath, modelSchema, queryProjection) {
@@ -770,9 +770,9 @@ function _getLocalFieldValues(doc, localField, model, options, virtual, schema)
 /**
  * Retrieve the _id of `val` if a Document or Array of Documents.
  *
- * @param {Array|Document|Any} val
+ * @param {Array|Document|any} val
  * @param {Schema} schema
- * @return {Array|Document|Any}
+ * @return {Array|Document|any}
  * @api private
  */
 

package/lib/helpers/populate/getSchemaTypes.js

@@ -20,7 +20,7 @@ const populateModelSymbol = require('../symbols').populateModelSymbol;
  *
  * @param {Model} model
  * @param {Schema} schema
- * @param {Object} doc POJO
+ * @param {object} doc POJO
  * @param {string} path
  * @param {string[]} [parts] pass in pre-split `path` to avoid extra splitting
  * @api private

package/lib/helpers/populate/markArraySubdocsPopulated.js

@@ -12,7 +12,7 @@ const utils = require('../../utils');
  *     doc.comments[0].populated('author'); // Should be set
  *
  * @param {Document} doc
- * @param {Object} [populated]
+ * @param {object} [populated]
  * @api private
  */
 

package/lib/helpers/populate/setPopulatedVirtualValue.js

@@ -3,11 +3,11 @@
 /**
  * Set a populated virtual value on a document's `$$populatedVirtuals` value
  *
- * @param {*} populatedVirtuals A document's `$$populatedVirtuals`
- * @param {*} name The virtual name
- * @param {*} v The result of the populate query
- * @param {*} options The populate options. This function handles `justOne` and `count` options.
- * @returns {Array<Document>|Document|Object|Array<Object>} the populated virtual value that was set
+ * @param {object} populatedVirtuals A document's `$$populatedVirtuals`
+ * @param {string} name The virtual name
+ * @param {any} v The result of the populate query
+ * @param {object} options The populate options. This function handles `justOne` and `count` options.
+ * @returns {Document[]|Document|object|object[]} the populated virtual value that was set
  */
 
 module.exports = function setPopulatedVirtualValue(populatedVirtuals, name, v, options) {

package/lib/helpers/projection/hasIncludedChildren.js

@@ -12,7 +12,7 @@
  *     res['a.b.c']; // 1
  *     res['a.c']; // undefined
  *
- * @param {Object} fields
+ * @param {object} fields
  * @api private
  */
 

package/lib/helpers/projection/isPathExcluded.js

@@ -5,9 +5,9 @@ const isDefiningProjection = require('./isDefiningProjection');
 /**
  * Determines if `path` is excluded by `projection`
  *
- * @param {Object} projection
- * @param {String} path
- * @return {Boolean}
+ * @param {object} projection
+ * @param {string} path
+ * @return {boolean}
  * @api private
  */
 

package/lib/helpers/projection/isSubpath.js

@@ -5,7 +5,7 @@
  *
  * @param {string} path1
  * @param {string} path2
- * @return {Boolean}
+ * @return {boolean}
  * @api private
  */
 

package/lib/helpers/query/castUpdate.js

@@ -39,11 +39,11 @@ const mongodbUpdateOperators = new Set([
  * Casts an update op based on the given schema
  *
  * @param {Schema} schema
- * @param {Object} obj
- * @param {Object} [options]
- * @param {Boolean|'throw'} [options.strict] defaults to true
+ * @param {object} obj
+ * @param {object} [options]
+ * @param {boolean|'throw'} [options.strict] defaults to true
  * @param {Query} context passed to setters
- * @return {Boolean} true iff the update is non-empty
+ * @return {boolean} true iff the update is non-empty
  * @api private
  */
 module.exports = function castUpdate(schema, obj, options, context, filter) {
@@ -202,13 +202,13 @@ function castPipelineOperator(op, val) {
  * according to its schema.
  *
  * @param {Schema} schema
- * @param {Object} obj part of a query
- * @param {String} op the atomic operator ($pull, $set, etc)
- * @param {Object} [options]
- * @param {Boolean|'throw'} [options.strict]
+ * @param {object} obj part of a query
+ * @param {string} op the atomic operator ($pull, $set, etc)
+ * @param {object} [options]
+ * @param {boolean|'throw'} [options.strict]
  * @param {Query} context
- * @param {Object} filter
- * @param {String} pref path prefix (internal only)
+ * @param {object} filter
+ * @param {string} pref path prefix (internal only)
  * @return {Bool} true if this path has keys to update
  * @api private
  */
@@ -532,11 +532,11 @@ const overwriteOps = {
  * Casts `val` according to `schema` and atomic `op`.
  *
  * @param {SchemaType} schema
- * @param {Object} val
- * @param {String} op the atomic operator ($pull, $set, etc)
- * @param {String} $conditional
+ * @param {object} val
+ * @param {string} op the atomic operator ($pull, $set, etc)
+ * @param {string} $conditional
  * @param {Query} context
- * @param {String} path
+ * @param {string} path
  * @api private
  */
 

package/lib/helpers/query/getEmbeddedDiscriminatorPath.js

@@ -9,10 +9,10 @@ const updatedPathsByArrayFilter = require('../update/updatedPathsByArrayFilter')
  * Like `schema.path()`, except with a document, because impossible to
  * determine path type without knowing the embedded discriminator key.
  * @param {Schema} schema
- * @param {Object} [update]
- * @param {Object} [filter]
- * @param {String} path
- * @param {Object} [options]
+ * @param {object} [update]
+ * @param {object} [filter]
+ * @param {string} path
+ * @param {object} [options]
  * @api private
  */
 

package/lib/helpers/query/handleImmutable.js

@@ -6,13 +6,13 @@ const StrictModeError = require('../../error/strict');
  * Handle immutable option for a given path when casting updates based on options
  *
  * @param {SchemaType} schematype the resolved schematype for this path
- * @param {Boolean | 'throw' | null} strict whether strict mode is set for this query
- * @param {Object} obj the object containing the value being checked so we can delete
- * @param {String} key the key in `obj` which we are checking for immutability
- * @param {String} fullPath the full path being checked
- * @param {Object} options the query options
+ * @param {boolean | 'throw' | null} strict whether strict mode is set for this query
+ * @param {object} obj the object containing the value being checked so we can delete
+ * @param {string} key the key in `obj` which we are checking for immutability
+ * @param {string} fullPath the full path being checked
+ * @param {object} options the query options
  * @param {Query} ctx the query. Passed as `this` and first param to the `immutable` option, if `immutable` is a function
- * @returns true if field was removed, false otherwise
+ * @returns {boolean} true if field was removed, false otherwise
  */
 
 module.exports = function handleImmutable(schematype, strict, obj, key, fullPath, options, ctx) {

package/lib/helpers/schema/getIndexes.js

@@ -135,7 +135,7 @@ module.exports = function getIndexes(schema) {
    *
    * schema._indexes = [ [indexObj, options], [indexObj, options] ..]
    * @param {Schema} schema
-   * @param {String} prefix
+   * @param {string} prefix
    * @api private
    */
 

package/lib/helpers/schema/getSubdocumentStrictValue.js

@@ -7,7 +7,7 @@
  * default, not the top-level document's.
  *
  * @param {Schema} schema
- * @param {String[]} parts
+ * @param {string[]} parts
  * @returns {boolean | 'throw' | undefined}
  */
 

package/lib/helpers/setDefaultsOnInsert.js

@@ -4,10 +4,10 @@ const get = require('./get');
 /**
  * Applies defaults to update and findOneAndUpdate operations.
  *
- * @param {Object} filter
+ * @param {object} filter
  * @param {Schema} schema
- * @param {Object} castedDoc
- * @param {Object} options
+ * @param {object} castedDoc
+ * @param {object} options
  * @method setDefaultsOnInsert
  * @api private
  */

package/lib/helpers/update/modifiedPaths.js

@@ -10,8 +10,8 @@ const _modifiedPaths = require('../common').modifiedPaths;
  * will get wrapped in a `$set`. The Mongoose Query is responsible for wrapping
  * top-level keys in `$set`.
  *
- * @param {Object} update
- * @return {Object} modified
+ * @param {object} update
+ * @return {object} modified
  */
 
 module.exports = function modifiedPaths(update) {

package/lib/helpers/updateValidators.js

@@ -14,8 +14,8 @@ const flatten = require('./common').flatten;
  *
  * @param {Query} query
  * @param {Schema} schema
- * @param {Object} castedDoc
- * @param {Object} options
+ * @param {object} castedDoc
+ * @param {object} options
  * @method runValidatorsOnUpdate
  * @api private
  */