mongoose 6.5.3 → 6.6.0

package/.mocharc.yml

@@ -0,0 +1,2 @@
+reporter: spec # better to identify failing / slow tests than "dot"
+ui: bdd # explicitly setting, even though it is mocha default

package/index.js

@@ -1,4 +1,3 @@
-
 /**
  * Export lib/mongoose
  *
@@ -11,3 +10,54 @@ const mongoose = require('./lib/');
 module.exports = mongoose;
 module.exports.default = mongoose;
 module.exports.mongoose = mongoose;
+
+// Re-export for ESM support
+module.exports.cast = mongoose.cast;
+module.exports.STATES = mongoose.STATES;
+module.exports.setDriver = mongoose.setDriver;
+module.exports.set = mongoose.set;
+module.exports.get = mongoose.get;
+module.exports.createConnection = mongoose.createConnection;
+module.exports.connect = mongoose.connect;
+module.exports.disconnect = mongoose.disconnect;
+module.exports.startSession = mongoose.startSession;
+module.exports.pluralize = mongoose.pluralize;
+module.exports.model = mongoose.model;
+module.exports.deleteModel = mongoose.deleteModel;
+module.exports.modelNames = mongoose.modelNames;
+module.exports.plugin = mongoose.plugin;
+module.exports.connections = mongoose.connections;
+module.exports.version = mongoose.version;
+module.exports.Mongoose = mongoose.Mongoose;
+module.exports.Schema = mongoose.Schema;
+module.exports.SchemaType = mongoose.SchemaType;
+module.exports.SchemaTypes = mongoose.SchemaTypes;
+module.exports.VirtualType = mongoose.VirtualType;
+module.exports.Types = mongoose.Types;
+module.exports.Query = mongoose.Query;
+module.exports.Promise = mongoose.Promise;
+module.exports.Model = mongoose.Model;
+module.exports.Document = mongoose.Document;
+module.exports.ObjectId = mongoose.ObjectId;
+module.exports.isValidObjectId = mongoose.isValidObjectId;
+module.exports.isObjectIdOrHexString = mongoose.isObjectIdOrHexString;
+module.exports.syncIndexes = mongoose.syncIndexes;
+module.exports.Decimal128 = mongoose.Decimal128;
+module.exports.Mixed = mongoose.Mixed;
+module.exports.Date = mongoose.Date;
+module.exports.Number = mongoose.Number;
+module.exports.Error = mongoose.Error;
+module.exports.now = mongoose.now;
+module.exports.CastError = mongoose.CastError;
+module.exports.SchemaTypeOptions = mongoose.SchemaTypeOptions;
+module.exports.mongo = mongoose.mongo;
+module.exports.mquery = mongoose.mquery;
+module.exports.sanitizeFilter = mongoose.sanitizeFilter;
+module.exports.trusted = mongoose.trusted;
+module.exports.skipMiddlewareFunction = mongoose.skipMiddlewareFunction;
+module.exports.overwriteMiddlewareResult = mongoose.overwriteMiddlewareResult;
+
+// The following properties are not exported using ESM because `setDriver()` can mutate these
+// module.exports.connection = mongoose.connection;
+// module.exports.Collection = mongoose.Collection;
+// module.exports.Connection = mongoose.Connection;

package/lib/aggregate.js

@@ -43,7 +43,7 @@ const validRedactStringValues = new Set(['$$DESCEND', '$$PRUNE', '$$KEEP']);
  *     new Aggregate([{ $match: { _id: new mongoose.Types.ObjectId('00000000000000000000000a') } }]);
  *
  * @see MongoDB https://docs.mongodb.org/manual/applications/aggregation/
- * @see driver https://mongodb.github.com/node-mongodb-native/api-generated/collection.html#aggregate
+ * @see driver https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#aggregate
  * @param {Array} [pipeline] aggregation pipeline as an array of objects
  * @param {Model} [model] the model to use with this aggregate.
  * @api public
@@ -304,6 +304,30 @@ Aggregate.prototype.project = function(arg) {
  * @api public
  */
 
+
+/**
+ * Appends a new $densify operator to this aggregate pipeline.
+ *
+ * #### Examples:
+ *
+ *      aggregate.densify({
+ *        field: 'timestamp',
+ *        range: {
+ *          step: 1,
+ *          unit: 'hour',
+ *          bounds: [new Date('2021-05-18T00:00:00.000Z'), new Date('2021-05-18T08:00:00.000Z')]
+ *        }
+ *      });
+ *
+ * @see $densify https://www.mongodb.com/docs/manual/reference/operator/aggregation/densify/
+ * @method densify
+ * @memberOf Aggregate
+ * @instance
+ * @param {Object} arg $densify operator contents
+ * @return {Aggregate}
+ * @api public
+ */
+
 /**
  * Appends a new $geoNear operator to this aggregate pipeline.
  *
@@ -342,7 +366,7 @@ Aggregate.prototype.near = function(arg) {
  * define methods
  */
 
-'group match skip limit out'.split(' ').forEach(function($operator) {
+'group match skip limit out densify'.split(' ').forEach(function($operator) {
   Aggregate.prototype[$operator] = function(arg) {
     const op = {};
     op['$' + $operator] = arg;
@@ -623,7 +647,6 @@ Aggregate.prototype.unionWith = function(options) {
  * @return {Aggregate} this
  * @api public
  * @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
  */
 
 Aggregate.prototype.read = function(pref, tags) {
@@ -766,7 +789,7 @@ Aggregate.prototype.explain = function(verbosity, callback) {
 };
 
 /**
- * Sets the allowDiskUse option for the aggregation query (ignored for < 2.6.0)
+ * Sets the allowDiskUse option for the aggregation query
  *
  * #### Example:
  *
@@ -783,7 +806,7 @@ Aggregate.prototype.allowDiskUse = function(value) {
 };
 
 /**
- * Sets the hint option for the aggregation query (ignored for < 3.6.0)
+ * Sets the hint option for the aggregation query
  *
  * #### Example:
  *
@@ -863,7 +886,7 @@ Aggregate.prototype.option = function(value) {
  * @param {Boolean} [options.useMongooseAggCursor] use experimental mongoose-specific aggregation cursor (for `eachAsync()` and other query cursor semantics)
  * @return {AggregationCursor} cursor representing this aggregation
  * @api public
- * @see mongodb https://mongodb.github.io/node-mongodb-native/2.0/api/AggregationCursor.html
+ * @see mongodb https://mongodb.github.io/node-mongodb-native/4.9/classes/AggregationCursor.html
  */
 
 Aggregate.prototype.cursor = function(options) {
@@ -881,7 +904,7 @@ Aggregate.prototype.cursor = function(options) {
  * @param {Object} collation options
  * @return {Aggregate} this
  * @api public
- * @see mongodb https://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#aggregate
+ * @see mongodb https://mongodb.github.io/node-mongodb-native/4.9/interfaces/CollationOptions.html
  */
 
 Aggregate.prototype.collation = function(collation) {
@@ -1050,7 +1073,7 @@ Aggregate.prototype.catch = function(reject) {
 };
 
 /**
- * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js
+ * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js)
  * You do not need to call this function explicitly, the JavaScript runtime
  * will call it for you.
  *
@@ -1104,12 +1127,13 @@ function isOperator(obj) {
   return k.length === 1 && k[0][0] === '$';
 }
 
-/*!
+/**
  * Adds the appropriate `$match` pipeline step to the top of an aggregate's
  * pipeline, should it's model is a non-root discriminator type. This is
  * analogous to the `prepareDiscriminatorCriteria` function in `lib/query.js`.
  *
  * @param {Aggregate} aggregate Aggregate to prepare
+ * @api private
  */
 
 Aggregate._prepareDiscriminatorPipeline = prepareDiscriminatorPipeline;

package/lib/cast/boolean.js

@@ -2,7 +2,7 @@
 
 const CastError = require('../error/cast');
 
-/*!
+/**
  * Given a value, cast it to a boolean, or throw a `CastError` if the value
  * cannot be casted. `null` and `undefined` are considered valid.
  *

package/lib/cast/number.js

@@ -2,7 +2,7 @@
 
 const assert = require('assert');
 
-/*!
+/**
  * Given a value, cast it to a number, or throw an `Error` if the value
  * cannot be casted. `null` and `undefined` are considered valid.
  *

package/lib/cast/string.js

@@ -2,7 +2,7 @@
 
 const CastError = require('../error/cast');
 
-/*!
+/**
  * Given a value, cast it to a string, or throw a `CastError` if the value
  * cannot be casted. `null` and `undefined` are considered valid.
  *

package/lib/cast.js

@@ -25,6 +25,9 @@ const ALLOWED_GEOWITHIN_GEOJSON_TYPES = ['Polygon', 'MultiPolygon'];
  * @param {Schema} schema
  * @param {Object} obj Object to cast
  * @param {Object} [options] the query options
+ * @param {Boolean|"throw"} [options.strict] Wheter to enable all strict options
+ * @param {Boolean|"throw"} [options.strictQuery] Enable strict Queries
+ * @param {Boolean} [options.upsert]
  * @param {Query} [context] passed to setters
  * @api private
  */

package/lib/connection.js

@@ -26,7 +26,7 @@ const processConnectionOptions = require('./helpers/processConnectionOptions');
 const arrayAtomicsSymbol = require('./helpers/symbols').arrayAtomicsSymbol;
 const sessionNewDocuments = require('./helpers/symbols').sessionNewDocuments;
 
-/*!
+/**
  * A list of authentication mechanisms that don't require a password for authentication.
  * This is used by the authMechanismDoesNotRequirePassword method.
  *
@@ -81,7 +81,7 @@ function Connection(base) {
  * Inherit from EventEmitter
  */
 
-Connection.prototype.__proto__ = EventEmitter.prototype;
+Object.setPrototypeOf(Connection.prototype, EventEmitter.prototype);
 
 /**
  * Connection ready state
@@ -387,11 +387,11 @@ Connection.prototype.config;
  * with specified options. Used to create [capped collections](https://docs.mongodb.com/manual/core/capped-collections/)
  * and [views](https://docs.mongodb.com/manual/core/views/) from mongoose.
  *
- * Options are passed down without modification to the [MongoDB driver's `createCollection()` function](https://mongodb.github.io/node-mongodb-native/2.2/api/Db.html#createCollection)
+ * Options are passed down without modification to the [MongoDB driver's `createCollection()` function](https://mongodb.github.io/node-mongodb-native/4.9/classes/Db.html#createCollection)
  *
  * @method createCollection
  * @param {string} collection The collection to create
- * @param {Object} [options] see [MongoDB driver docs](https://mongodb.github.io/node-mongodb-native/2.2/api/Db.html#createCollection)
+ * @param {Object} [options] see [MongoDB driver docs](https://mongodb.github.io/node-mongodb-native/4.9/classes/Db.html#createCollection)
  * @param {Function} [callback]
  * @return {Promise} Returns a Promise if no `callback` is given.
  * @api public
@@ -423,7 +423,7 @@ Connection.prototype.createCollection = _wrapConnHelper(function createCollectio
  *
  *
  * @method startSession
- * @param {Object} [options] see the [mongodb driver options](https://mongodb.github.io/node-mongodb-native/3.0/api/MongoClient.html#startSession)
+ * @param {Object} [options] see the [mongodb driver options](https://mongodb.github.io/node-mongodb-native/4.9/classes/MongoClient.html#startSession)
  * @param {Boolean} [options.causalConsistency=true] set to false to disable causal consistency
  * @param {Function} [callback]
  * @return {Promise<ClientSession>} promise that resolves to a MongoDB driver `ClientSession`
@@ -445,7 +445,7 @@ Connection.prototype.startSession = _wrapConnHelper(function startSession(option
  * async function executes successfully and attempt to retry if
  * there was a retriable error.
  *
- * Calls the MongoDB driver's [`session.withTransaction()`](https://mongodb.github.io/node-mongodb-native/3.5/api/ClientSession.html#withTransaction),
+ * Calls the MongoDB driver's [`session.withTransaction()`](https://mongodb.github.io/node-mongodb-native/4.9/classes/ClientSession.html#withTransaction),
  * but also handles resetting Mongoose document state as shown below.
  *
  * #### Example:
@@ -656,7 +656,7 @@ Connection.prototype.onOpen = function() {
  * Opens the connection with a URI using `MongoClient.connect()`.
  *
  * @param {String} uri The URI to connect with.
- * @param {Object} [options] Passed on to https://mongodb.github.io/node-mongodb-native/2.2/api/MongoClient.html#connect
+ * @param {Object} [options] Passed on to [`MongoClient.connect`](https://mongodb.github.io/node-mongodb-native/4.9/classes/MongoClient.html#connect-1)
  * @param {Boolean} [options.bufferCommands=true] Mongoose specific option. Set to false to [disable buffering](https://mongoosejs.com/docs/faq.html#callback_never_executes) on all models associated with this connection.
  * @param {Number} [options.bufferTimeoutMS=10000] Mongoose specific option. If `bufferCommands` is true, Mongoose will throw an error after `bufferTimeoutMS` if the operation is still buffered.
  * @param {String} [options.dbName] The name of the database we want to use. If not provided, use database name from connection string.
@@ -667,7 +667,7 @@ Connection.prototype.onOpen = function() {
  * @param {Number} [options.serverSelectionTimeoutMS] If `useUnifiedTopology = true`, the MongoDB driver will try to find a server to send any given operation to, and keep retrying for `serverSelectionTimeoutMS` milliseconds before erroring out. If not set, the MongoDB driver defaults to using `30000` (30 seconds).
  * @param {Number} [options.heartbeatFrequencyMS] If `useUnifiedTopology = true`, the MongoDB driver sends a heartbeat every `heartbeatFrequencyMS` to check on the status of the connection. A heartbeat is subject to `serverSelectionTimeoutMS`, so the MongoDB driver will retry failed heartbeats for up to 30 seconds by default. Mongoose only emits a `'disconnected'` event after a heartbeat has failed, so you may want to decrease this setting to reduce the time between when your server goes down and when Mongoose emits `'disconnected'`. We recommend you do **not** set this setting below 1000, too many heartbeats can lead to performance degradation.
  * @param {Boolean} [options.autoIndex=true] Mongoose-specific option. Set to false to disable automatic index creation for all models associated with this connection.
- * @param {Class} [options.promiseLibrary] Sets the [underlying driver's promise library](https://mongodb.github.io/node-mongodb-native/3.1/api/MongoClient.html).
+ * @param {Class} [options.promiseLibrary] Sets the [underlying driver's promise library](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/MongoClientOptions.html#promiseLibrary).
  * @param {Number} [options.connectTimeoutMS=30000] How long the MongoDB driver will wait before killing a socket due to inactivity _during initial connection_. Defaults to 30000. This option is passed transparently to [Node.js' `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback).
  * @param {Number} [options.socketTimeoutMS=30000] How long the MongoDB driver will wait before killing a socket due to inactivity _after initial connection_. A socket may be inactive because of either no activity or a long-running operation. This is set to `30000` by default, you should set this to 2-3x your longest running operation if you expect some of your database operations to run longer than 20 seconds. This option is passed to [Node.js `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback) after the MongoDB driver successfully completes.
  * @param {Number} [options.family=0] Passed transparently to [Node.js' `dns.lookup()`](https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback) function. May be either `0, `4`, or `6`. `4` means use IPv4 only, `6` means use IPv6 only, `0` means try both.
@@ -1230,6 +1230,14 @@ Connection.prototype.model = function(name, schema, collection, options) {
     return sub;
   }
 
+  if (arguments.length === 1) {
+    model = this.models[name];
+    if (!model) {
+      throw new MongooseError.MissingSchemaError(name);
+    }
+    return model;
+  }
+
   if (!model) {
     throw new MongooseError.MissingSchemaError(name);
   }
@@ -1324,7 +1332,7 @@ Connection.prototype.deleteModel = function(name) {
  *
  * @api public
  * @param {Array} [pipeline]
- * @param {Object} [options] passed without changes to [the MongoDB driver's `Db#watch()` function](https://mongodb.github.io/node-mongodb-native/3.4/api/Db.html#watch)
+ * @param {Object} [options] passed without changes to [the MongoDB driver's `Db#watch()` function](https://mongodb.github.io/node-mongodb-native/4.9/classes/Db.html#watch)
  * @return {ChangeStream} mongoose-specific change stream wrapper, inherits from EventEmitter
  */
 
@@ -1426,7 +1434,7 @@ Connection.prototype.optionsProvideAuthenticationData = function(options) {
 };
 
 /**
- * Returns the [MongoDB driver `MongoClient`](https://mongodb.github.io/node-mongodb-native/3.5/api/MongoClient.html) instance
+ * Returns the [MongoDB driver `MongoClient`](https://mongodb.github.io/node-mongodb-native/4.9/classes/MongoClient.html) instance
  * that this connection uses to talk to MongoDB.
  *
  * #### Example:
@@ -1445,7 +1453,7 @@ Connection.prototype.getClient = function getClient() {
 };
 
 /**
- * Set the [MongoDB driver `MongoClient`](https://mongodb.github.io/node-mongodb-native/3.5/api/MongoClient.html) instance
+ * Set the [MongoDB driver `MongoClient`](https://mongodb.github.io/node-mongodb-native/4.9/classes/MongoClient.html) instance
  * that this connection uses to talk to MongoDB. This is useful if you already have a MongoClient instance, and want to
  * reuse it.
  *

package/lib/cursor/AggregationCursor.js

@@ -71,8 +71,12 @@ function _init(model, c, agg) {
   }
 }
 
-/*!
+/**
  * Necessary to satisfy the Readable API
+ * @method _read
+ * @memberOf AggregationCursor
+ * @instance
+ * @api private
  */
 
 AggregationCursor.prototype._read = function() {
@@ -147,8 +151,12 @@ Object.defineProperty(AggregationCursor.prototype, 'map', {
   writable: true
 });
 
-/*!
+/**
  * Marks this cursor as errored
+ * @method _markError
+ * @instance
+ * @memberOf AggregationCursor
+ * @api private
  */
 
 AggregationCursor.prototype._markError = function(error) {
@@ -165,7 +173,7 @@ AggregationCursor.prototype._markError = function(error) {
  * @api public
  * @method close
  * @emits close
- * @see MongoDB driver cursor#close https://mongodb.github.io/node-mongodb-native/2.1/api/Cursor.html#close
+ * @see AggregationCursor.close https://mongodb.github.io/node-mongodb-native/4.9/classes/AggregationCursor.html#close
  */
 
 AggregationCursor.prototype.close = function(callback) {
@@ -223,7 +231,7 @@ AggregationCursor.prototype.eachAsync = function(fn, opts, callback) {
 };
 
 /**
- * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js
+ * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js)
  * You do not need to call this function explicitly, the JavaScript runtime
  * will call it for you.
  *
@@ -293,7 +301,7 @@ function _transformForAsyncIterator(doc) {
 }
 
 /**
- * Adds a [cursor flag](https://mongodb.github.io/node-mongodb-native/2.2/api/Cursor.html#addCursorFlag).
+ * Adds a [cursor flag](https://mongodb.github.io/node-mongodb-native/4.9/classes/AggregationCursor.html#addCursorFlag).
  * Useful for setting the `noCursorTimeout` and `tailable` flags.
  *
  * @param {String} flag
@@ -324,9 +332,12 @@ function _waitForCursor(ctx, cb) {
   });
 }
 
-/*!
+/**
  * Get the next doc from the underlying cursor and mongooseify it
  * (populate, etc.)
+ * @param {Any} ctx
+ * @param {Function} cb
+ * @api private
  */
 
 function _next(ctx, cb) {

package/lib/cursor/QueryCursor.js

@@ -85,8 +85,12 @@ function QueryCursor(query, options) {
 
 util.inherits(QueryCursor, Readable);
 
-/*!
+/**
  * Necessary to satisfy the Readable API
+ * @method _read
+ * @memberOf QueryCursor
+ * @instance
+ * @api private
  */
 
 QueryCursor.prototype._read = function() {
@@ -152,8 +156,12 @@ Object.defineProperty(QueryCursor.prototype, 'map', {
   writable: true
 });
 
-/*!
+/**
  * Marks this cursor as errored
+ * @method _markError
+ * @memberOf QueryCursor
+ * @instance
+ * @api private
  */
 
 QueryCursor.prototype._markError = function(error) {
@@ -170,7 +178,7 @@ QueryCursor.prototype._markError = function(error) {
  * @api public
  * @method close
  * @emits close
- * @see MongoDB driver cursor#close https://mongodb.github.io/node-mongodb-native/2.1/api/Cursor.html#close
+ * @see AggregationCursor.close https://mongodb.github.io/node-mongodb-native/4.9/classes/AggregationCursor.html#close
  */
 
 QueryCursor.prototype.close = function(callback) {
@@ -255,7 +263,7 @@ QueryCursor.prototype.eachAsync = function(fn, opts, callback) {
 QueryCursor.prototype.options;
 
 /**
- * Adds a [cursor flag](https://mongodb.github.io/node-mongodb-native/2.2/api/Cursor.html#addCursorFlag).
+ * Adds a [cursor flag](https://mongodb.github.io/node-mongodb-native/4.9/classes/FindCursor.html#addCursorFlag).
  * Useful for setting the `noCursorTimeout` and `tailable` flags.
  *
  * @param {String} flag
@@ -340,9 +348,12 @@ function _transformForAsyncIterator(doc) {
   return doc == null ? { done: true } : { value: doc, done: false };
 }
 
-/*!
+/**
  * Get the next doc from the underlying cursor and mongooseify it
  * (populate, etc.)
+ * @param {Any} ctx
+ * @param {Function} cb
+ * @api private
  */
 
 function _next(ctx, cb) {

package/lib/document.js

@@ -696,12 +696,15 @@ Document.prototype.$__init = function(doc, opts) {
   return this;
 };
 
-/*!
+/**
  * Init helper.
  *
  * @param {Object} self document instance
  * @param {Object} obj raw mongodb doc
  * @param {Object} doc object we are initializing
+ * @param {Object} [opts] Optional Options
+ * @param {Boolean} [opts.setters] Call `applySetters` instead of `cast`
+ * @param {String} [prefix] Prefix to add to each path
  * @api private
  */
 
@@ -3678,7 +3681,7 @@ Document.prototype.$toObject = function(options, json) {
 /**
  * Converts this document into a plain-old JavaScript object ([POJO](https://masteringjs.io/tutorials/fundamentals/pojo)).
  *
- * Buffers are converted to instances of [mongodb.Binary](https://mongodb.github.com/node-mongodb-native/api-bson-generated/binary.html) for proper storage.
+ * Buffers are converted to instances of [mongodb.Binary](https://mongodb.github.io/node-mongodb-native/4.9/classes/Binary.html) for proper storage.
  *
  * #### Getters/Virtuals
  *
@@ -3805,7 +3808,7 @@ Document.prototype.$toObject = function(options, json) {
  * @param {Boolean} [options.flattenMaps=false] if true, convert Maps to POJOs. Useful if you want to `JSON.stringify()` the result of `toObject()`.
  * @param {Boolean} [options.useProjection=false] - If true, omits fields that are excluded in this document's projection. Unless you specified a projection, this will omit any field that has `select: false` in the schema.
  * @return {Object} js object (not a POJO)
- * @see mongodb.Binary https://mongodb.github.com/node-mongodb-native/api-bson-generated/binary.html
+ * @see mongodb.Binary https://mongodb.github.io/node-mongodb-native/4.9/classes/Binary.html
  * @api public
  * @memberOf Document
  * @instance
@@ -3815,11 +3818,12 @@ Document.prototype.toObject = function(options) {
   return this.$toObject(options);
 };
 
-/*!
+/**
  * Minimizes an object, removing undefined values and empty objects
  *
  * @param {Object} object to minimize
  * @return {Object}
+ * @api private
  */
 
 function minimize(obj) {
@@ -3925,12 +3929,14 @@ function applyVirtuals(self, json, options, toObjectOptions) {
 }
 
 
-/*!
+/**
  * Applies virtuals properties to `json`.
  *
  * @param {Document} self
  * @param {Object} json
+ * @param {Object} [options]
  * @return {Object} `json`
+ * @api private
  */
 
 function applyGetters(self, json, options) {
@@ -3980,12 +3986,13 @@ function applyGetters(self, json, options) {
   return json;
 }
 
-/*!
+/**
  * Applies schema type transforms to `json`.
  *
  * @param {Document} self
  * @param {Object} json
  * @return {Object} `json`
+ * @api private
  */
 
 function applySchemaTypeTransforms(self, json) {
@@ -4158,10 +4165,7 @@ Document.prototype.inspect = function(options) {
 };
 
 if (inspect.custom) {
-  /*!
-  * Avoid Node deprecation warning DEP0079
-  */
-
+  // Avoid Node deprecation warning DEP0079
   Document.prototype[inspect.custom] = Document.prototype.inspect;
 }
 
@@ -4417,8 +4421,13 @@ Document.prototype.$populated = Document.prototype.populated;
  *     doc.$assertPopulated('author'); // does not throw
  *     doc.$assertPopulated('other path'); // throws an error
  *
+ *     // Manually populate and assert in one call. The following does
+ *     // `doc.$set({ likes })` before asserting.
+ *     doc.$assertPopulated('likes', { likes });
  *
- * @param {String|String[]} paths
+ *
+ * @param {String|String[]} path path or array of paths to check. `$assertPopulated` throws if any of the given paths is not populated.
+ * @param {Object} [values] optional values to `$set()`. Convenient if you want to manually populate a path and assert that the path was populated in 1 call.
  * @return {Document} this
  * @memberOf Document
  * @method $assertPopulated
@@ -4426,14 +4435,18 @@ Document.prototype.$populated = Document.prototype.populated;
  * @api public
  */
 
-Document.prototype.$assertPopulated = function $assertPopulated(paths) {
-  if (Array.isArray(paths)) {
-    paths.forEach(path => this.$assertPopulated(path));
+Document.prototype.$assertPopulated = function $assertPopulated(path, values) {
+  if (Array.isArray(path)) {
+    path.forEach(p => this.$assertPopulated(p, values));
     return this;
   }
 
-  if (!this.$populated(paths)) {
-    throw new MongooseError(`Expected path "${paths}" to be populated`);
+  if (arguments.length > 1) {
+    this.$set(values);
+  }
+
+  if (!this.$populated(path)) {
+    throw new MongooseError(`Expected path "${path}" to be populated`);
   }
 
   return this;

package/lib/drivers/browser/objectid.js

@@ -9,8 +9,9 @@
 
 const ObjectId = require('bson').ObjectID;
 
-/*!
+/**
  * Getter for convenience with populate, see gh-6115
+ * @api private
  */
 
 Object.defineProperty(ObjectId.prototype, '_id', {

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

@@ -7,7 +7,7 @@
 const mongodb = require('mongodb');
 const ReadPref = mongodb.ReadPreference;
 
-/*!
+/**
  * Converts arguments to ReadPrefs the driver
  * can understand.
  *

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

@@ -34,7 +34,7 @@ function NativeCollection(name, conn, options) {
  * Inherit from abstract Collection.
  */
 
-NativeCollection.prototype.__proto__ = MongooseCollection.prototype;
+Object.setPrototypeOf(NativeCollection.prototype, MongooseCollection.prototype);
 
 /**
  * Called when the connection opens.
@@ -66,8 +66,10 @@ NativeCollection.prototype.onClose = function(force) {
 
 const syncCollectionMethods = { watch: true, find: true, aggregate: true };
 
-/*!
+/**
  * Copy the collection methods and make them subject to queues
+ * @param {Number|String} I
+ * @api private
  */
 
 function iter(i) {
@@ -296,8 +298,10 @@ NativeCollection.prototype.$format = function(arg, color, shell) {
   return format(arg, false, color, shell);
 };
 
-/*!
+/**
  * Debug print helper
+ * @param {Any} representation
+ * @api private
  */
 
 function inspectable(representation) {

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

@@ -32,7 +32,7 @@ NativeConnection.STATES = STATES;
  * Inherits from Connection.
  */
 
-NativeConnection.prototype.__proto__ = MongooseConnection.prototype;
+Object.setPrototypeOf(NativeConnection.prototype, MongooseConnection.prototype);
 
 /**
  * Switches to a different database using the same connection pool.

package/lib/error/browserMissingSchema.js

@@ -8,7 +8,7 @@ const MongooseError = require('./');
 
 
 class MissingSchemaError extends MongooseError {
-  /*!
+  /**
    * MissingSchema Error constructor.
    */
   constructor() {