mongoose 6.4.4 → 6.4.7

package/lib/query.js

@@ -2133,7 +2133,7 @@ Query.prototype._unsetCastError = function _unsetCastError() {
  * Below are the current Mongoose-specific options.
  *
  * - `populate`: an array representing what paths will be populated. Should have one entry for each call to [`Query.prototype.populate()`](/docs/api.html#query_Query-populate)
- * - `lean`: if truthy, Mongoose will not [hydrate](/docs/api.html#model_Model.hydrate) any documents that are returned from this query. See [`Query.prototype.lean()`](/docs/api.html#query_Query-lean) for more information.
+ * - `lean`: if truthy, Mongoose will not [hydrate](/docs/api.html#model_Model-hydrate) any documents that are returned from this query. See [`Query.prototype.lean()`](/docs/api.html#query_Query-lean) for more information.
  * - `strict`: controls how Mongoose handles keys that aren't in the schema for updates. This option is `true` by default, which means Mongoose will silently strip any paths in the update that aren't in the schema. See the [`strict` mode docs](/docs/guide.html#strict) for more information.
  * - `strictQuery`: controls how Mongoose handles keys that aren't in the schema for the query `filter`. This option is `false` by default for backwards compatibility, which means Mongoose will allow `Model.find({ foo: 'bar' })` even if `foo` is not in the schema. See the [`strictQuery` docs](/docs/guide.html#strictQuery) for more information.
  * - `nearSphere`: use `$nearSphere` instead of `near()`. See the [`Query.prototype.nearSphere()` docs](/docs/api.html#query_Query-nearSphere)
@@ -4019,7 +4019,9 @@ Query.prototype._findAndModify = function(type, callback) {
  */
 
 function _completeOneLean(schema, doc, path, res, opts, callback) {
-  if (opts.lean && opts.lean.transform) {
+  if (opts.lean && typeof opts.lean.transform === 'function') {
+    opts.lean.transform(doc);
+
     for (let i = 0; i < schema.childSchemas.length; i++) {
       const childPath = path ? path + '.' + schema.childSchemas[i].model.path : schema.childSchemas[i].model.path;
       const _schema = schema.childSchemas[i].schema;
@@ -4053,7 +4055,11 @@ function _completeOneLean(schema, doc, path, res, opts, callback) {
  */
 
 function _completeManyLean(schema, docs, path, opts, callback) {
-  if (opts.lean && opts.lean.transform) {
+  if (opts.lean && typeof opts.lean.transform === 'function') {
+    for (const doc of docs) {
+      opts.lean.transform(doc);
+    }
+
     for (let i = 0; i < schema.childSchemas.length; i++) {
       const childPath = path ? path + '.' + schema.childSchemas[i].model.path : schema.childSchemas[i].model.path;
       const _schema = schema.childSchemas[i].schema;
@@ -4239,7 +4245,7 @@ Query.prototype.validate = function validate(castedDoc, options, isOverwriting,
  * Internal thunk for .update()
  *
  * @param {Function} callback
- * @see Model.update #model_Model.update
+ * @see Model.update #model_Model-update
  * @api private
  */
 Query.prototype._execUpdate = wrapThunk(function(callback) {
@@ -4250,7 +4256,7 @@ Query.prototype._execUpdate = wrapThunk(function(callback) {
  * Internal thunk for .updateMany()
  *
  * @param {Function} callback
- * @see Model.update #model_Model.update
+ * @see Model.update #model_Model-update
  * @api private
  */
 Query.prototype._updateMany = wrapThunk(function(callback) {
@@ -4261,7 +4267,7 @@ Query.prototype._updateMany = wrapThunk(function(callback) {
  * Internal thunk for .updateOne()
  *
  * @param {Function} callback
- * @see Model.update #model_Model.update
+ * @see Model.update #model_Model-update
  * @api private
  */
 Query.prototype._updateOne = wrapThunk(function(callback) {
@@ -4272,7 +4278,7 @@ Query.prototype._updateOne = wrapThunk(function(callback) {
  * Internal thunk for .replaceOne()
  *
  * @param {Function} callback
- * @see Model.replaceOne #model_Model.replaceOne
+ * @see Model.replaceOne #model_Model-replaceOne
  * @api private
  */
 Query.prototype._replaceOne = wrapThunk(function(callback) {
@@ -4362,7 +4368,7 @@ Query.prototype._replaceOne = wrapThunk(function(callback) {
  * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
  * @param {Function} [callback] params are (error, writeOpResult)
  * @return {Query} this
- * @see Model.update #model_Model.update
+ * @see Model.update #model_Model-update
  * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see update https://docs.mongodb.org/manual/reference/method/db.collection.update/
  * @see writeOpResult https://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~WriteOpResult
@@ -4426,7 +4432,7 @@ Query.prototype.update = function(conditions, doc, options, callback) {
  * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
  * @param {Function} [callback] params are (error, writeOpResult)
  * @return {Query} this
- * @see Model.update #model_Model.update
+ * @see Model.update #model_Model-update
  * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see update https://docs.mongodb.org/manual/reference/method/db.collection.update/
  * @see writeOpResult https://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~WriteOpResult
@@ -4491,7 +4497,7 @@ Query.prototype.updateMany = function(conditions, doc, options, callback) {
  * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Note that this allows you to overwrite timestamps. Does nothing if schema-level timestamps are not set.
  * @param {Function} [callback] params are (error, writeOpResult)
  * @return {Query} this
- * @see Model.update #model_Model.update
+ * @see Model.update #model_Model-update
  * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see update https://docs.mongodb.org/manual/reference/method/db.collection.update/
  * @see writeOpResult https://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~WriteOpResult
@@ -4554,7 +4560,7 @@ Query.prototype.updateOne = function(conditions, doc, options, callback) {
  * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
  * @param {Function} [callback] params are (error, writeOpResult)
  * @return {Query} this
- * @see Model.update #model_Model.update
+ * @see Model.update #model_Model-update
  * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see update https://docs.mongodb.org/manual/reference/method/db.collection.update/
  * @see writeOpResult https://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~WriteOpResult
@@ -5055,7 +5061,7 @@ function castQuery(query) {
  * @param {Object} [options.options=null] Additional options like `limit` and `lean`.
  * @see population ./populate.html
  * @see Query#select #query_Query-select
- * @see Model.populate #model_Model.populate
+ * @see Model.populate #model_Model-populate
  * @return {Query} this
  * @api public
  */

package/lib/schema.js

@@ -554,6 +554,10 @@ Schema.prototype.add = function add(obj, prefix) {
   const keys = Object.keys(obj);
   const typeKey = this.options.typeKey;
   for (const key of keys) {
+    if (utils.specialProperties.has(key)) {
+      continue;
+    }
+
     const fullPath = prefix + key;
     const val = obj[key];
 
@@ -854,6 +858,9 @@ Schema.prototype.path = function(path, obj) {
   let fullPath = '';
 
   for (const sub of subpaths) {
+    if (utils.specialProperties.has(sub)) {
+      throw new Error('Cannot set special property `' + sub + '` on a schema');
+    }
     fullPath = fullPath += (fullPath.length > 0 ? '.' : '') + sub;
     if (!branch[sub]) {
       this.nested[fullPath] = true;
@@ -1691,7 +1698,7 @@ Schema.prototype.post = function(name) {
  *
  * @param {Function} plugin The Plugin's callback
  * @param {Object} [opts] Options to pass to the plugin
- * @see plugins
+ * @see plugins /docs/plugins.html
  * @api public
  */
 

package/lib/schematype.js

@@ -134,6 +134,7 @@ SchemaType.prototype.OptionsConstructor = SchemaTypeOptions;
  * The path to this SchemaType in a Schema.
  *
  * #### Example:
+ *
  *     const schema = new Schema({ name: String });
  *     schema.path('name').path; // 'name'
  *
@@ -148,6 +149,7 @@ SchemaType.prototype.path;
  * The validators that Mongoose should run to validate properties at this SchemaType's path.
  *
  * #### Example:
+ *
  *     const schema = new Schema({ name: { type: String, required: true } });
  *     schema.path('name').validators.length; // 1, the `required` validator
  *
@@ -162,6 +164,7 @@ SchemaType.prototype.validators;
  * True if this SchemaType has a required validator. False otherwise.
  *
  * #### Example:
+ *
  *     const schema = new Schema({ name: { type: String, required: true } });
  *     schema.path('name').isRequired; // true
  *
@@ -175,8 +178,11 @@ SchemaType.prototype.validators;
 
 SchemaType.prototype.validators;
 
-/*!
- * ignore
+/**
+ * Split the current dottet path into segments
+ *
+ * @return {String[]|undefined}
+ * @api private
  */
 
 SchemaType.prototype.splitPath = function() {
@@ -351,8 +357,8 @@ SchemaType.get = function(getter) {
  *     const m2 = new M;
  *     console.log(m2.mixed); // { added: 1 }
  *
- * @param {Function|any} val the default value
- * @return {defaultValue}
+ * @param {Function|any} val The default value to set
+ * @return {Any|undefined} Returns the set default value.
  * @api public
  */
 
@@ -414,7 +420,7 @@ SchemaType.prototype.index = function(options) {
  *
  * #### Example:
  *
- *     const s = new Schema({ name: { type: String, unique: true }});
+ *     const s = new Schema({ name: { type: String, unique: true } });
  *     s.path('name').index({ unique: true });
  *
  * _NOTE: violating the constraint returns an `E11000` error from MongoDB when saving, not a Mongoose validation error._
@@ -452,8 +458,9 @@ SchemaType.prototype.unique = function(bool) {
  *
  * ### Example:
  *
- *      const s = new Schema({name : {type: String, text : true })
- *      s.path('name').index({text : true});
+ *      const s = new Schema({ name : { type: String, text : true } })
+ *      s.path('name').index({ text : true });
+ *
  * @param {Boolean} bool
  * @return {SchemaType} this
  * @api public
@@ -462,7 +469,7 @@ SchemaType.prototype.unique = function(bool) {
 SchemaType.prototype.text = function(bool) {
   if (this._index === false) {
     if (!bool) {
-      return;
+      return this;
     }
     throw new Error('Path "' + this.path + '" may not have `index` set to ' +
       'false and `text` set to true');
@@ -499,7 +506,7 @@ SchemaType.prototype.text = function(bool) {
 SchemaType.prototype.sparse = function(bool) {
   if (this._index === false) {
     if (!bool) {
-      return;
+      return this;
     }
     throw new Error('Path "' + this.path + '" may not have `index` set to ' +
       'false and `sparse` set to true');
@@ -606,19 +613,17 @@ SchemaType.prototype.transform = function(fn) {
  *
  * #### Example:
  *
- * ```javascript
- * function capitalize (val) {
- *   if (typeof val !== 'string') val = '';
- *   return val.charAt(0).toUpperCase() + val.substring(1);
- * }
+ *     function capitalize (val) {
+ *       if (typeof val !== 'string') val = '';
+ *       return val.charAt(0).toUpperCase() + val.substring(1);
+ *     }
  *
- * // defining within the schema
- * const s = new Schema({ name: { type: String, set: capitalize }});
+ *     // defining within the schema
+ *     const s = new Schema({ name: { type: String, set: capitalize }});
  *
- * // or with the SchemaType
- * const s = new Schema({ name: String })
- * s.path('name').set(capitalize);
- * ```
+ *     // or with the SchemaType
+ *     const s = new Schema({ name: String })
+ *     s.path('name').set(capitalize);
  *
  * Setters allow you to transform the data before it gets to the raw mongodb
  * document or query.
@@ -630,76 +635,68 @@ SchemaType.prototype.transform = function(fn) {
  *
  * You can set up email lower case normalization easily via a Mongoose setter.
  *
- * ```javascript
- * function toLower(v) {
- *   return v.toLowerCase();
- * }
+ *     function toLower(v) {
+ *       return v.toLowerCase();
+ *     }
  *
- * const UserSchema = new Schema({
- *   email: { type: String, set: toLower }
- * });
+ *     const UserSchema = new Schema({
+ *       email: { type: String, set: toLower }
+ *     });
  *
- * const User = db.model('User', UserSchema);
+ *     const User = db.model('User', UserSchema);
  *
- * const user = new User({email: 'AVENUE@Q.COM'});
- * console.log(user.email); // 'avenue@q.com'
+ *     const user = new User({email: 'AVENUE@Q.COM'});
+ *     console.log(user.email); // 'avenue@q.com'
  *
- * // or
- * const user = new User();
- * user.email = 'Avenue@Q.com';
- * console.log(user.email); // 'avenue@q.com'
- * User.updateOne({ _id: _id }, { $set: { email: 'AVENUE@Q.COM' } }); // update to 'avenue@q.com'
- * ```
+ *     // or
+ *     const user = new User();
+ *     user.email = 'Avenue@Q.com';
+ *     console.log(user.email); // 'avenue@q.com'
+ *     User.updateOne({ _id: _id }, { $set: { email: 'AVENUE@Q.COM' } }); // update to 'avenue@q.com'
  *
  * As you can see above, setters allow you to transform the data before it
  * stored in MongoDB, or before executing a query.
  *
  * _NOTE: we could have also just used the built-in `lowercase: true` SchemaType option instead of defining our own function._
  *
- * ```javascript
- * new Schema({ email: { type: String, lowercase: true }})
- * ```
+ *     new Schema({ email: { type: String, lowercase: true }})
  *
  * Setters are also passed a second argument, the schematype on which the setter was defined. This allows for tailored behavior based on options passed in the schema.
  *
- * ```javascript
- * function inspector (val, priorValue, schematype) {
- *   if (schematype.options.required) {
- *     return schematype.path + ' is required';
- *   } else {
- *     return val;
- *   }
- * }
+ *     function inspector (val, priorValue, schematype) {
+ *       if (schematype.options.required) {
+ *         return schematype.path + ' is required';
+ *       } else {
+ *         return val;
+ *       }
+ *     }
  *
- * const VirusSchema = new Schema({
- *   name: { type: String, required: true, set: inspector },
- *   taxonomy: { type: String, set: inspector }
- * })
+ *     const VirusSchema = new Schema({
+ *       name: { type: String, required: true, set: inspector },
+ *       taxonomy: { type: String, set: inspector }
+ *     })
  *
- * const Virus = db.model('Virus', VirusSchema);
- * const v = new Virus({ name: 'Parvoviridae', taxonomy: 'Parvovirinae' });
+ *     const Virus = db.model('Virus', VirusSchema);
+ *     const v = new Virus({ name: 'Parvoviridae', taxonomy: 'Parvovirinae' });
  *
- * console.log(v.name);     // name is required
- * console.log(v.taxonomy); // Parvovirinae
- * ```
+ *     console.log(v.name);     // name is required
+ *     console.log(v.taxonomy); // Parvovirinae
  *
  * You can also use setters to modify other properties on the document. If
  * you're setting a property `name` on a document, the setter will run with
  * `this` as the document. Be careful, in mongoose 5 setters will also run
  * when querying by `name` with `this` as the query.
  *
- * ```javascript
- * const nameSchema = new Schema({ name: String, keywords: [String] });
- * nameSchema.path('name').set(function(v) {
- *   // Need to check if `this` is a document, because in mongoose 5
- *   // setters will also run on queries, in which case `this` will be a
- *   // mongoose query object.
- *   if (this instanceof Document && v != null) {
- *     this.keywords = v.split(' ');
- *   }
- *   return v;
- * });
- * ```
+ *     const nameSchema = new Schema({ name: String, keywords: [String] });
+ *     nameSchema.path('name').set(function(v) {
+ *       // Need to check if `this` is a document, because in mongoose 5
+ *       // setters will also run on queries, in which case `this` will be a
+ *       // mongoose query object.
+ *       if (this instanceof Document && v != null) {
+ *         this.keywords = v.split(' ');
+ *       }
+ *       return v;
+ *     });
  *
  * @param {Function} fn
  * @return {SchemaType} this
@@ -824,7 +821,7 @@ SchemaType.prototype.get = function(fn) {
  * From the examples above, you may have noticed that error messages support
  * basic templating. There are a few other template keywords besides `{PATH}`
  * and `{VALUE}` too. To find out more, details are available
- * [here](#error_messages_MongooseError.messages).
+ * [here](#error_messages_MongooseError-messages).
  *
  * If Mongoose's built-in error message templating isn't enough, Mongoose
  * supports setting the `message` property to a function.
@@ -993,9 +990,9 @@ SchemaType.prototype.validate = function(obj, message, type) {
  * @param {String} [message] optional custom error message
  * @return {SchemaType} this
  * @see Customized Error Messages #error_messages_MongooseError-messages
- * @see SchemaArray#checkRequired #schema_array_SchemaArray.checkRequired
+ * @see SchemaArray#checkRequired #schema_array_SchemaArray-checkRequired
  * @see SchemaBoolean#checkRequired #schema_boolean_SchemaBoolean-checkRequired
- * @see SchemaBuffer#checkRequired #schema_buffer_SchemaBuffer.schemaName
+ * @see SchemaBuffer#checkRequired #schema_buffer_SchemaBuffer-schemaName
  * @see SchemaNumber#checkRequired #schema_number_SchemaNumber-min
  * @see SchemaObjectId#checkRequired #schema_objectid_ObjectId-auto
  * @see SchemaString#checkRequired #schema_string_SchemaString-checkRequired
@@ -1079,6 +1076,7 @@ SchemaType.prototype.required = function(required, message) {
  * looks at to determine the foreign collection it should query.
  *
  * #### Example:
+ *
  *     const userSchema = new Schema({ name: String });
  *     const User = mongoose.model('User', userSchema);
  *
@@ -1108,6 +1106,7 @@ SchemaType.prototype.ref = function(ref) {
  *
  * @param {Object} scope the scope which callback are executed
  * @param {Boolean} init
+ * @return {Any} The Stored default value.
  * @api private
  */
 
@@ -1175,6 +1174,7 @@ SchemaType.prototype._castNullish = function _castNullish(v) {
  * @param {Object} value
  * @param {Object} scope
  * @param {Boolean} init
+ * @return {Any}
  * @api private
  */
 
@@ -1195,6 +1195,7 @@ SchemaType.prototype.applySetters = function(value, scope, init, priorVal, optio
  *
  * @param {Object} value
  * @param {Object} scope
+ * @return {Any}
  * @api private
  */
 
@@ -1239,9 +1240,12 @@ SchemaType.prototype.select = function select(val) {
 /**
  * Performs a validation of `value` using the validators declared for this SchemaType.
  *
- * @param {any} value
+ * @param {Any} value
  * @param {Function} callback
  * @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
  */
 
@@ -1352,9 +1356,11 @@ function _validate(ok, validatorProperties) {
  *
  * This method ignores the asynchronous validators.
  *
- * @param {any} value
+ * @param {Any} value
  * @param {Object} scope
- * @return {MongooseError|undefined}
+ * @param {Object} [options]
+ * @param {Object} [options.path]
+ * @return {MongooseError|null}
  * @api private
  */
 
@@ -1595,7 +1601,8 @@ SchemaType.prototype.castForQueryWrapper = function(params) {
  * Cast the given value with the given optional query operator.
  *
  * @param {String} [$conditional] query operator, like `$eq` or `$in`
- * @param {any} val
+ * @param {Any} val
+ * @return {Any}
  * @api private
  */
 
@@ -1612,9 +1619,11 @@ SchemaType.prototype.castForQuery = function($conditional, val) {
   return this._castForQuery(val);
 };
 
-/*!
+/**
  * Internal switch for runSetters
  *
+ * @param {Any} val
+ * @return {Any}
  * @api private
  */
 
@@ -1623,6 +1632,7 @@ SchemaType.prototype._castForQuery = function(val) {
 };
 
 /**
+ * Set & Get the `checkRequired` function
  * Override the function the required validator uses to check whether a value
  * passes the `required` check. Override this on the individual SchemaType.
  *
@@ -1631,8 +1641,8 @@ SchemaType.prototype._castForQuery = function(val) {
  *     // Use this to allow empty strings to pass the `required` validator
  *     mongoose.Schema.Types.String.checkRequired(v => typeof v === 'string');
  *
- * @param {Function} fn
- * @return {Function}
+ * @param {Function} [fn] If set, will overwrite the current set function
+ * @return {Function} The input `fn` or the already set function
  * @static
  * @memberOf SchemaType
  * @function checkRequired
@@ -1650,7 +1660,8 @@ SchemaType.checkRequired = function(fn) {
 /**
  * Default check for if this path satisfies the `required` validator.
  *
- * @param {any} val
+ * @param {Any} val
+ * @return {Boolean} `true` when the value is not `null`, `false` otherwise
  * @api private
  */
 
@@ -1658,8 +1669,11 @@ SchemaType.prototype.checkRequired = function(val) {
   return val != null;
 };
 
-/*!
- * ignore
+/**
+ * Clone the current SchemaType
+ *
+ * @return {SchemaType} The cloned SchemaType instance
+ * @api private
  */
 
 SchemaType.prototype.clone = function() {

package/lib/virtualtype.js

@@ -13,18 +13,18 @@ const utils = require('./utils');
  *     fullname instanceof mongoose.VirtualType // true
  *
  * @param {Object} options
- * @param {string|function} [options.ref] if `ref` is not nullish, this becomes a [populated virtual](/docs/populate.html#populate-virtuals)
- * @param {string|function} [options.localField] the local field to populate on if this is a populated virtual.
- * @param {string|function} [options.foreignField] the foreign field to populate on if this is a populated virtual.
- * @param {boolean} [options.justOne=false] by default, a populated virtual is an array. If you set `justOne`, the populated virtual will be a single doc or `null`.
- * @param {boolean} [options.getters=false] if you set this to `true`, Mongoose will call any custom getters you defined on this virtual
- * @param {boolean} [options.count=false] if you set this to `true`, `populate()` will set this virtual to the number of populated documents, as opposed to the documents themselves, using [`Query#countDocuments()`](./api.html#query_Query-countDocuments)
+ * @param {String|Function} [options.ref] if `ref` is not nullish, this becomes a [populated virtual](/docs/populate.html#populate-virtuals)
+ * @param {String|Function} [options.localField] the local field to populate on if this is a populated virtual.
+ * @param {String|Function} [options.foreignField] the foreign field to populate on if this is a populated virtual.
+ * @param {Boolean} [options.justOne=false] by default, a populated virtual is an array. If you set `justOne`, the populated virtual will be a single doc or `null`.
+ * @param {Boolean} [options.getters=false] if you set this to `true`, Mongoose will call any custom getters you defined on this virtual
+ * @param {Boolean} [options.count=false] if you set this to `true`, `populate()` will set this virtual to the number of populated documents, as opposed to the documents themselves, using [`Query#countDocuments()`](./api.html#query_Query-countDocuments)
  * @param {Object|Function} [options.match=null] add an extra match condition to `populate()`
  * @param {Number} [options.limit=null] add a default `limit` to the `populate()` query
  * @param {Number} [options.skip=null] add a default `skip` to the `populate()` query
  * @param {Number} [options.perDocumentLimit=null] For legacy reasons, `limit` with `populate()` may give incorrect results because it only executes a single query for every document being populated. If you set `perDocumentLimit`, Mongoose will ensure correct `limit` per document by executing a separate query for each document to `populate()`. For example, `.find().populate({ path: 'test', perDocumentLimit: 2 })` will execute 2 additional queries if `.find()` returns 2 documents.
  * @param {Object} [options.options=null] Additional options like `limit` and `lean`.
- * @param {string} name
+ * @param {String} name
  * @api public
  */
 
@@ -36,10 +36,8 @@ function VirtualType(options, name) {
 }
 
 /**
- * If no getters/getters, add a default
+ * If no getters/setters, add a default
  *
- * @param {Function} fn
- * @return {VirtualType} this
  * @api private
  */
 
@@ -51,10 +49,10 @@ VirtualType.prototype._applyDefaultGetters = function() {
   const path = this.path;
   const internalProperty = '$' + path;
   this.getters.push(function() {
-    return this[internalProperty];
+    return this.$locals[internalProperty];
   });
   this.setters.push(function(v) {
-    this[internalProperty] = v;
+    this.$locals[internalProperty] = v;
   });
 };
 
@@ -85,7 +83,7 @@ VirtualType.prototype.clone = function() {
  *       return this.name.first + ' ' + this.name.last;
  *     });
  *
- * @param {function} fn
+ * @param {Function} fn
  * @return {VirtualType} this
  * @api public
  */
@@ -120,7 +118,7 @@ VirtualType.prototype.get = function(fn) {
  *     doc.name.first; // 'Jean-Luc'
  *     doc.name.last; // 'Picard'
  *
- * @param {function} fn
+ * @param {Function} fn
  * @return {VirtualType} this
  * @api public
  */
@@ -135,7 +133,7 @@ VirtualType.prototype.set = function(fn) {
  *
  * @param {Object} value
  * @param {Document} doc The document this virtual is attached to
- * @return {any} the value after applying all getters
+ * @return {Any} the value after applying all getters
  * @api public
  */
 
@@ -158,7 +156,7 @@ VirtualType.prototype.applyGetters = function(value, doc) {
  *
  * @param {Object} value
  * @param {Document} doc
- * @return {any} the value after applying all setters
+ * @return {Any} the value after applying all setters
  * @api public
  */
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "6.4.4",
+  "version": "6.4.7",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -60,7 +60,7 @@
     "serve-handler": "6.1.3",
     "sinon": "14.0.0",
     "stream-browserify": "3.0.0",
-    "ts-benchmark": "^1.0.2",
+    "ts-benchmark": "^1.1.10",
     "tsd": "0.20.0",
     "typescript": "4.7.4",
     "uuid": "8.3.2",
@@ -98,8 +98,8 @@
     "test-tsd": "node ./test/types/check-types-filename && tsd",
     "tdd": "mocha ./test/*.test.js --inspect --watch --recursive --watch-files ./**/*.{js,ts}",
     "test-coverage": "nyc --reporter=html --reporter=text npm test",
-    "ts-benchmark": "node ./benchmarks/typescript.js",
-    "ts-benchmark-watch": "ts-benchmark -p ./benchmarks/typescript/simple -w ./types -i -s -f 17 18 29 32 -b master"
+    "ts-benchmark": "ts-benchmark -p ./benchmarks/typescript/simple -f 17/100000 18 29 32",
+    "ts-benchmark-watch": "ts-benchmark -p ./benchmarks/typescript/simple -w ./types -i -s -f 17/100000 18 29 32 -b master"
   },
   "main": "./index.js",
   "types": "./types/index.d.ts",

package/types/connection.d.ts

@@ -229,7 +229,7 @@ declare module 'mongoose' {
     /** The username specified in the URI */
     readonly user: string;
 
-    /** Watches the entire underlying database for changes. Similar to [`Model.watch()`](/docs/api/model.html#model_Model.watch). */
+    /** Watches the entire underlying database for changes. Similar to [`Model.watch()`](/docs/api/model.html#model_Model-watch). */
     watch<ResultType extends mongodb.Document = any>(pipeline?: Array<any>, options?: mongodb.ChangeStreamOptions): mongodb.ChangeStream<ResultType>;
   }