mongoose 6.5.2 → 6.5.5

package/lib/query.js

@@ -1191,7 +1191,7 @@ Query.prototype.select = function select() {
  *     // read from secondaries with matching tags
  *     new Query().read('s', [{ dc:'sf', s: 1 },{ dc:'ma', s: 2 }])
  *
- * Read more about how to use read preferences [here](https://docs.mongodb.org/manual/applications/replication/#read-preference) and [here](https://mongodb.github.com/node-mongodb-native/driver-articles/anintroductionto1_1and2_2.html#read-preferences).
+ * Read more about how to use read preferences [here](https://docs.mongodb.org/manual/applications/replication/#read-preference).
  *
  * @method read
  * @memberOf Query
@@ -1199,7 +1199,6 @@ Query.prototype.select = function select() {
  * @param {String} pref one of the listed preference options or aliases
  * @param {Array} [tags] optional tags for this query
  * @see mongodb https://docs.mongodb.org/manual/applications/replication/#read-preference
- * @see driver https://mongodb.github.com/node-mongodb-native/driver-articles/anintroductionto1_1and2_2.html#read-preferences
  * @return {Query} this
  * @api public
  */
@@ -1211,8 +1210,13 @@ Query.prototype.read = function read(pref, tags) {
   return this;
 };
 
-/*!
- * ignore
+/**
+ * Overwrite default `.toString` to make logging more useful
+ *
+ * @memberOf Query
+ * @instance
+ * @method toString
+ * @api private
  */
 
 Query.prototype.toString = function toString() {
@@ -1306,7 +1310,7 @@ Query.prototype.session = function session(v) {
  * @memberOf Query
  * @instance
  * @param {Object} writeConcern the write concern value to set
- * @see mongodb https://mongodb.github.io/node-mongodb-native/3.1/api/global.html#WriteConcern
+ * @see WriteConcernSettings https://mongodb.github.io/node-mongodb-native/4.9/interfaces/WriteConcernSettings.html
  * @return {Query} this
  * @api public
  */
@@ -2127,8 +2131,12 @@ Query.prototype.error = function error(err) {
   return this;
 };
 
-/*!
+/**
  * ignore
+ * @method _unsetCastError
+ * @instance
+ * @memberOf Query
+ * @api private
  */
 
 Query.prototype._unsetCastError = function _unsetCastError() {
@@ -2164,8 +2172,12 @@ Query.prototype.mongooseOptions = function(v) {
   return this._mongooseOptions;
 };
 
-/*!
+/**
  * ignore
+ * @method _castConditions
+ * @memberOf Query
+ * @api private
+ * @instance
  */
 
 Query.prototype._castConditions = function() {
@@ -2617,7 +2629,7 @@ Query.prototype._count = wrapThunk(function(callback) {
  * Thunk around countDocuments()
  *
  * @param {Function} [callback]
- * @see countDocuments https://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#countDocuments
+ * @see countDocuments https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#countDocuments
  * @api private
  */
 
@@ -2645,7 +2657,7 @@ Query.prototype._countDocuments = wrapThunk(function(callback) {
  * Thunk around estimatedDocumentCount()
  *
  * @param {Function} [callback]
- * @see estimatedDocumentCount https://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#estimatedDocumentCount
+ * @see estimatedDocumentCount https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#estimatedDocumentCount
  * @api private
  */
 
@@ -2733,10 +2745,10 @@ Query.prototype.count = function(filter, callback) {
  *
  *     await Model.find().estimatedDocumentCount();
  *
- * @param {Object} [options] passed transparently to the [MongoDB driver](https://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#estimatedDocumentCount)
+ * @param {Object} [options] passed transparently to the [MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/EstimatedDocumentCountOptions.html)
  * @param {Function} [callback] optional params are (error, count)
  * @return {Query} this
- * @see estimatedDocumentCount https://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#estimatedDocumentCount
+ * @see estimatedDocumentCount https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#estimatedDocumentCount
  * @api public
  */
 
@@ -2766,7 +2778,7 @@ Query.prototype.estimatedDocumentCount = function(options, callback) {
  * except it always does a full collection scan when passed an empty filter `{}`.
  *
  * There are also minor differences in how `countDocuments()` handles
- * [`$where` and a couple geospatial operators](https://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#countDocuments).
+ * [`$where` and a couple geospatial operators](https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#countDocuments).
  * versus `count()`.
  *
  * Passing a `callback` executes the query.
@@ -2789,7 +2801,7 @@ Query.prototype.estimatedDocumentCount = function(options, callback) {
  *     });
  *
  * The `countDocuments()` function is similar to `count()`, but there are a
- * [few operators that `countDocuments()` does not support](https://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#countDocuments).
+ * [few operators that `countDocuments()` does not support](https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#countDocuments).
  * Below are the operators that `count()` supports but `countDocuments()` does not,
  * and the suggested replacement:
  *
@@ -2801,7 +2813,7 @@ Query.prototype.estimatedDocumentCount = function(options, callback) {
  * @param {Object} [options]
  * @param {Function} [callback] optional params are (error, count)
  * @return {Query} this
- * @see countDocuments https://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#countDocuments
+ * @see countDocuments https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#countDocuments
  * @api public
  */
 
@@ -2968,7 +2980,7 @@ Query.prototype.sort = function(arg) {
  *
  *     Character.remove({ name: /Stark/ }, callback);
  *
- * This function calls the MongoDB driver's [`Collection#remove()` function](https://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#remove).
+ * This function calls the MongoDB driver's [`Collection#remove()` function](https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#remove).
  * The returned [promise](https://mongoosejs.com/docs/queries.html) resolves to an
  * object that contains 3 properties:
  *
@@ -3002,8 +3014,8 @@ Query.prototype.sort = function(arg) {
  * @param {Function} [callback] optional params are (error, mongooseDeleteResult)
  * @return {Query} this
  * @deprecated
- * @see deleteWriteOpResult https://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#~deleteWriteOpResult
- * @see MongoDB driver remove https://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#remove
+ * @see DeleteResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/DeleteResult.html
+ * @see remove https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#remove
  * @api public
  */
 
@@ -3032,8 +3044,13 @@ Query.prototype.remove = function(filter, callback) {
   return this;
 };
 
-/*!
+/**
  * ignore
+ * @param {Function} callback
+ * @method _remove
+ * @memberOf Query
+ * @instance
+ * @api private
  */
 
 Query.prototype._remove = wrapThunk(function(callback) {
@@ -3063,7 +3080,7 @@ Query.prototype._remove = wrapThunk(function(callback) {
  *     // Using callbacks:
  *     Character.deleteOne({ name: 'Eddard Stark' }, callback);
  *
- * This function calls the MongoDB driver's [`Collection#deleteOne()` function](https://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#deleteOne).
+ * This function calls the MongoDB driver's [`Collection#deleteOne()` function](https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#deleteOne).
  * The returned [promise](https://mongoosejs.com/docs/queries.html) resolves to an
  * object that contains 3 properties:
  *
@@ -3081,8 +3098,8 @@ Query.prototype._remove = wrapThunk(function(callback) {
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api.html#query_Query-setOptions)
  * @param {Function} [callback] optional params are (error, mongooseDeleteResult)
  * @return {Query} this
- * @see deleteWriteOpResult https://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#~deleteWriteOpResult
- * @see MongoDB Driver deleteOne https://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#deleteOne
+ * @see DeleteResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/DeleteResult.html
+ * @see deleteOne https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#deleteOne
  * @api public
  */
 
@@ -3118,8 +3135,13 @@ Query.prototype.deleteOne = function(filter, options, callback) {
   return this;
 };
 
-/*!
+/**
  * Internal thunk for `deleteOne()`
+ * @param {Function} callback
+ * @method _deleteOne
+ * @instance
+ * @memberOf Query
+ * @api private
  */
 
 Query.prototype._deleteOne = wrapThunk(function(callback) {
@@ -3149,7 +3171,7 @@ Query.prototype._deleteOne = wrapThunk(function(callback) {
  *     // Using callbacks:
  *     Character.deleteMany({ name: /Stark/, age: { $gte: 18 } }, callback);
  *
- * This function calls the MongoDB driver's [`Collection#deleteMany()` function](https://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#deleteMany).
+ * This function calls the MongoDB driver's [`Collection#deleteMany()` function](https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#deleteMany).
  * The returned [promise](https://mongoosejs.com/docs/queries.html) resolves to an
  * object that contains 3 properties:
  *
@@ -3167,8 +3189,8 @@ Query.prototype._deleteOne = wrapThunk(function(callback) {
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api.html#query_Query-setOptions)
  * @param {Function} [callback] optional params are (error, mongooseDeleteResult)
  * @return {Query} this
- * @see deleteWriteOpResult https://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#~deleteWriteOpResult
- * @see MongoDB Driver deleteMany https://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#deleteMany
+ * @see DeleteResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/DeleteResult.html
+ * @see deleteMany https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#deleteMany
  * @api public
  */
 
@@ -3204,8 +3226,13 @@ Query.prototype.deleteMany = function(filter, options, callback) {
   return this;
 };
 
-/*!
+/**
  * Internal thunk around `deleteMany()`
+ * @param {Function} callback
+ * @method _deleteMany
+ * @instance
+ * @memberOf Query
+ * @api private
  */
 
 Query.prototype._deleteMany = wrapThunk(function(callback) {
@@ -3221,7 +3248,7 @@ Query.prototype._deleteMany = wrapThunk(function(callback) {
   return Query.base.deleteMany.call(this, callback);
 });
 
-/*!
+/**
  * hydrates a document
  *
  * @param {Model} model
@@ -3231,6 +3258,7 @@ Query.prototype._deleteMany = wrapThunk(function(callback) {
  * @param {Query} self
  * @param {Array} [pop] array of paths used in population
  * @param {Function} callback
+ * @api private
  */
 
 function completeOne(model, doc, res, options, fields, userProvidedFields, pop, callback) {
@@ -3265,8 +3293,10 @@ function completeOne(model, doc, res, options, fields, userProvidedFields, pop,
   }
 }
 
-/*!
+/**
  * If the model is a discriminator type and not root, then add the key & value to the criteria.
+ * @param {Query} query
+ * @api private
  */
 
 function prepareDiscriminatorCriteria(query) {
@@ -3301,7 +3331,7 @@ function prepareDiscriminatorCriteria(query) {
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
  * - `runValidators`: if true, runs [update validators](/docs/validation.html#update-validators) on this command. Update validators validate the update operation against the model's schema.
  * - `setDefaultsOnInsert`: `true` by default. If `setDefaultsOnInsert` and `upsert` are true, mongoose will apply the [defaults](https://mongoosejs.com/docs/defaults.html) specified in the model's schema if a new document is created.
- * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
+ * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html)
  *
  * #### Callback Signature
  *
@@ -3327,7 +3357,7 @@ function prepareDiscriminatorCriteria(query) {
  * @param {Object|Query} [filter]
  * @param {Object} [doc]
  * @param {Object} [options]
- * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
+ * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html)
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.html).
  * @param {Boolean} [options.multipleCastError] by default, mongoose only returns the first error that occurred in casting the query. Turn on this option to aggregate all the cast errors.
@@ -3339,8 +3369,9 @@ function prepareDiscriminatorCriteria(query) {
  * @param {Boolean} [options.returnOriginal=null] An alias for the `new` option. `returnOriginal: false` is equivalent to `new: true`.
  * @param {Function} [callback] optional params are (error, doc), _unless_ `rawResult` is used, in which case params are (error, writeOpResult)
  * @see Tutorial /docs/tutorials/findoneandupdate.html
- * @see mongodb https://www.mongodb.org/display/DOCS/findAndModify+Command
- * @see writeOpResult https://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~WriteOpResult
+ * @see findAndModify command https://www.mongodb.com/docs/manual/reference/command/findAndModify/
+ * @see ModifyResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html
+ * @see findOneAndUpdate https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#findOneAndUpdate
  * @return {Query} this
  * @api public
  */
@@ -3415,10 +3446,12 @@ Query.prototype.findOneAndUpdate = function(criteria, doc, options, callback) {
   return this;
 };
 
-/*!
+/**
  * Thunk around findOneAndUpdate()
  *
  * @param {Function} [callback]
+ * @method _findOneAndUpdate
+ * @memberOf Query
  * @api private
  */
 
@@ -3444,7 +3477,7 @@ Query.prototype._findOneAndUpdate = wrapThunk(function(callback) {
  *
  * - `sort`: if multiple docs are found by the conditions, sets the sort order to choose which doc to update
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
- * - `rawResult`: if true, resolves to the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
+ * - `rawResult`: if true, resolves to the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html)
  *
  * #### Callback Signature
  *
@@ -3467,12 +3500,12 @@ Query.prototype._findOneAndUpdate = wrapThunk(function(callback) {
  * @instance
  * @param {Object} [conditions]
  * @param {Object} [options]
- * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
+ * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html)
  * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.html).
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {Function} [callback] optional params are (error, document)
  * @return {Query} this
- * @see mongodb https://www.mongodb.org/display/DOCS/findAndModify+Command
+ * @see findAndModify command https://www.mongodb.com/docs/manual/reference/command/findAndModify/
  * @api public
  */
 
@@ -3532,7 +3565,7 @@ Query.prototype.findOneAndRemove = function(conditions, options, callback) {
  *
  * - `sort`: if multiple docs are found by the conditions, sets the sort order to choose which doc to update
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
- * - `rawResult`: if true, resolves to the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
+ * - `rawResult`: if true, resolves to the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html)
  *
  * #### Callback Signature
  *
@@ -3554,12 +3587,12 @@ Query.prototype.findOneAndRemove = function(conditions, options, callback) {
  * @memberOf Query
  * @param {Object} [conditions]
  * @param {Object} [options]
- * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
+ * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html)
  * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.html).
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {Function} [callback] optional params are (error, document)
  * @return {Query} this
- * @see mongodb https://www.mongodb.org/display/DOCS/findAndModify+Command
+ * @see findAndModify command https://www.mongodb.com/docs/manual/reference/command/findAndModify/
  * @api public
  */
 
@@ -3599,11 +3632,13 @@ Query.prototype.findOneAndDelete = function(conditions, options, callback) {
   return this;
 };
 
-/*!
+/**
  * Thunk around findOneAndDelete()
  *
  * @param {Function} [callback]
  * @return {Query} this
+ * @method _findOneAndDelete
+ * @memberOf Query
  * @api private
  */
 Query.prototype._findOneAndDelete = wrapThunk(function(callback) {
@@ -3652,7 +3687,7 @@ Query.prototype._findOneAndDelete = wrapThunk(function(callback) {
  *
  * - `sort`: if multiple docs are found by the conditions, sets the sort order to choose which doc to update
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
- * - `rawResult`: if true, resolves to the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
+ * - `rawResult`: if true, resolves to the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html)
  *
  * #### Callback Signature
  *
@@ -3675,7 +3710,7 @@ Query.prototype._findOneAndDelete = wrapThunk(function(callback) {
  * @param {Object} [filter]
  * @param {Object} [replacement]
  * @param {Object} [options]
- * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
+ * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html)
  * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.html).
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {Boolean} [options.new=false] By default, `findOneAndUpdate()` returns the document as it was **before** `update` was applied. If you set `new: true`, `findOneAndUpdate()` will instead give you the object after `update` was applied.
@@ -3750,11 +3785,14 @@ Query.prototype.findOneAndReplace = function(filter, replacement, options, callb
   return this;
 };
 
-/*!
+/**
  * Thunk around findOneAndReplace()
  *
  * @param {Function} [callback]
  * @return {Query} this
+ * @method _findOneAndReplace
+ * @instance
+ * @memberOf Query
  * @api private
  */
 Query.prototype._findOneAndReplace = wrapThunk(function(callback) {
@@ -3827,9 +3865,10 @@ Query.prototype._findOneAndReplace = wrapThunk(function(callback) {
   });
 });
 
-/*!
+/**
  * Support the `new` option as an alternative to `returnOriginal` for backwards
  * compat.
+ * @api private
  */
 
 function convertNewToReturnDocument(options) {
@@ -3847,11 +3886,14 @@ function convertNewToReturnDocument(options) {
   }
 }
 
-/*!
+/**
  * Thunk around findOneAndRemove()
  *
  * @param {Function} [callback]
  * @return {Query} this
+ * @method _findOneAndRemove
+ * @memberOf Query
+ * @instance
  * @api private
  */
 Query.prototype._findOneAndRemove = wrapThunk(function(callback) {
@@ -3863,8 +3905,12 @@ Query.prototype._findOneAndRemove = wrapThunk(function(callback) {
   this._findAndModify('remove', callback);
 });
 
-/*!
+/**
  * Get options from query opts, falling back to the base mongoose object.
+ * @param {Query} query
+ * @param {Object} option
+ * @param {Any} def
+ * @api private
  */
 
 function _getOption(query, option, def) {
@@ -3879,11 +3925,14 @@ function _getOption(query, option, def) {
   return def;
 }
 
-/*!
+/**
  * Override mquery.prototype._findAndModify to provide casting etc.
  *
  * @param {String} type either "remove" or "update"
  * @param {Function} callback
+ * @method _findAndModify
+ * @memberOf Query
+ * @instance
  * @api private
  */
 
@@ -4094,11 +4143,14 @@ function _completeManyLean(schema, docs, path, opts, callback) {
   }
   return callback(null, docs);
 }
-/*!
+/**
  * Override mquery.prototype._mergeUpdate to handle mongoose objects in
  * updates.
  *
  * @param {Object} doc
+ * @method _mergeUpdate
+ * @memberOf Query
+ * @instance
  * @api private
  */
 
@@ -4130,9 +4182,12 @@ Query.prototype._mergeUpdate = function(doc) {
   }
 };
 
-/*!
+/**
  * The mongodb driver 1.3.23 only supports the nested array sort
  * syntax. We must convert it or sorting findAndModify will not work.
+ * @param {Object} opts
+ * @param {Array|Object} opts.sort
+ * @api private
  */
 
 function convertSortToArray(opts) {
@@ -4229,13 +4284,17 @@ function _updateThunk(op, callback) {
   return null;
 }
 
-/*!
+/**
  * Mongoose calls this function internally to validate the query if
  * `runValidators` is set
  *
  * @param {Object} castedDoc the update, after casting
  * @param {Object} options the options from `_optionsForExec()`
+ * @param {Boolean} isOverwriting
  * @param {Function} callback
+ * @method validate
+ * @memberOf Query
+ * @instance
  * @api private
  */
 
@@ -4255,44 +4314,56 @@ Query.prototype.validate = function validate(castedDoc, options, isOverwriting,
   });
 };
 
-/*!
+/**
  * Internal thunk for .update()
  *
  * @param {Function} callback
  * @see Model.update #model_Model-update
+ * @method _execUpdate
+ * @memberOf Query
+ * @instance
  * @api private
  */
 Query.prototype._execUpdate = wrapThunk(function(callback) {
   return _updateThunk.call(this, 'update', callback);
 });
 
-/*!
+/**
  * Internal thunk for .updateMany()
  *
  * @param {Function} callback
  * @see Model.update #model_Model-update
+ * @method _updateMany
+ * @memberOf Query
+ * @instance
  * @api private
  */
 Query.prototype._updateMany = wrapThunk(function(callback) {
   return _updateThunk.call(this, 'updateMany', callback);
 });
 
-/*!
+/**
  * Internal thunk for .updateOne()
  *
  * @param {Function} callback
  * @see Model.update #model_Model-update
+ * @method _updateOne
+ * @memberOf Query
+ * @instance
  * @api private
  */
 Query.prototype._updateOne = wrapThunk(function(callback) {
   return _updateThunk.call(this, 'updateOne', callback);
 });
 
-/*!
+/**
  * Internal thunk for .replaceOne()
  *
  * @param {Function} callback
  * @see Model.replaceOne #model_Model-replaceOne
+ * @method _replaceOne
+ * @memberOf Query
+ * @instance
  * @api private
  */
 Query.prototype._replaceOne = wrapThunk(function(callback) {
@@ -4385,7 +4456,7 @@ Query.prototype._replaceOne = wrapThunk(function(callback) {
  * @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
+ * @see UpdateResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/UpdateResult.html
  * @see MongoDB docs https://docs.mongodb.com/manual/reference/command/update/#update-command-output
  * @api public
  */
@@ -4450,7 +4521,7 @@ Query.prototype.update = function(conditions, doc, options, callback) {
  * @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
+ * @see UpdateResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/UpdateResult.html
  * @see MongoDB docs https://docs.mongodb.com/manual/reference/command/update/#update-command-output
  * @api public
  */
@@ -4516,7 +4587,7 @@ Query.prototype.updateMany = function(conditions, doc, options, callback) {
  * @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
+ * @see UpdateResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/UpdateResult.html
  * @see MongoDB docs https://docs.mongodb.com/manual/reference/command/update/#update-command-output
  * @api public
  */
@@ -4580,7 +4651,7 @@ Query.prototype.updateOne = function(conditions, doc, options, callback) {
  * @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
+ * @see UpdateResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/UpdateResult.html
  * @see MongoDB docs https://docs.mongodb.com/manual/reference/command/update/#update-command-output
  * @api public
  */
@@ -4614,8 +4685,15 @@ Query.prototype.replaceOne = function(conditions, doc, options, callback) {
   return _update(this, 'replaceOne', conditions, doc, options, callback);
 };
 
-/*!
+/**
  * Internal helper for update, updateMany, updateOne, replaceOne
+ * @param {Query} query
+ * @param {String} op
+ * @param {Object} filter
+ * @param {Document} [doc]
+ * @param {Object} [options]
+ * @param {Function} callback
+ * @api private
  */
 
 function _update(query, op, filter, doc, options, callback) {
@@ -4763,8 +4841,11 @@ Query.prototype.orFail = function(err) {
   return this;
 };
 
-/*!
+/**
  * Get the error to throw for `orFail()`
+ * @param {Error|undefined} err
+ * @param {Query} query
+ * @api private
  */
 
 function _orFailError(err, query) {
@@ -4970,11 +5051,15 @@ Query.prototype.post = function(fn) {
   return this;
 };
 
-/*!
+/**
  * Casts obj for an update command.
  *
  * @param {Object} obj
+ * @param {Boolean} overwrite
  * @return {Object} obj after casting its values
+ * @method _castUpdate
+ * @memberOf Query
+ * @instance
  * @api private
  */
 
@@ -5018,7 +5103,7 @@ Query.prototype._castUpdate = function _castUpdate(obj, overwrite) {
   }, this, this._conditions);
 };
 
-/*!
+/**
  * castQuery
  * @api private
  */
@@ -5312,7 +5397,7 @@ Query.prototype._applyPaths = function applyPaths() {
 };
 
 /**
- * Returns a wrapper around a [mongodb driver cursor](https://mongodb.github.io/node-mongodb-native/2.1/api/Cursor.html).
+ * Returns a wrapper around a [mongodb driver cursor](https://mongodb.github.io/node-mongodb-native/4.9/classes/FindCursor.html).
  * A QueryCursor exposes a Streams3 interface, as well as a `.next()` function.
  *
  * The `.cursor()` function triggers pre find hooks, but **not** post find hooks.
@@ -5533,7 +5618,7 @@ Query.prototype.tailable = function(val, opts) {
  * @api public
  */
 
-/*!
+/**
  * Overwriting mquery is needed to support a couple different near() forms found in older
  * versions of mongoose
  * near([1,1])
@@ -5541,6 +5626,11 @@ Query.prototype.tailable = function(val, opts) {
  * near(field, [1,2])
  * near(field, 1, 2)
  * In addition to all of the normal forms supported by mquery
+ *
+ * @method near
+ * @memberOf Query
+ * @instance
+ * @api private
  */
 
 Query.prototype.near = function() {
@@ -5692,10 +5782,15 @@ if (Symbol.asyncIterator != null) {
  * @api public
  */
 
-/*!
+/**
  * this is needed to support the mongoose syntax of:
  * box(field, { ll : [x,y], ur : [x2,y2] })
  * box({ ll : [x,y], ur : [x2,y2] })
+ *
+ * @method box
+ * @memberOf Query
+ * @instance
+ * @api private
  */
 
 Query.prototype.box = function(ll, ur) {