mongoose 6.4.3 → 6.4.4

package/lib/aggregate.js

@@ -481,7 +481,8 @@ Aggregate.prototype.sortByCount = function(arg) {
  *
  * @see $lookup https://docs.mongodb.org/manual/reference/operator/aggregation/lookup/#pipe._S_lookup
  * @param {Object} options to $lookup as described in the above link
- * @return {Aggregate}* @api public
+ * @return {Aggregate}
+ * @api public
  */
 
 Aggregate.prototype.lookup = function(options) {
@@ -1051,7 +1052,7 @@ Aggregate.prototype.catch = function(reject) {
  * You do not need to call this function explicitly, the JavaScript runtime
  * will call it for you.
  *
- * #### Example
+ * #### Example:
  *
  *     const agg = Model.aggregate([{ $match: { age: { $gte: 25 } } }]);
  *     for await (const doc of agg) {

package/lib/connection.js

@@ -93,7 +93,7 @@ Connection.prototype.__proto__ = EventEmitter.prototype;
  *
  * Each state change emits its associated event name.
  *
- * #### Example
+ * #### Example:
  *
  *     conn.on('connected', callback);
  *     conn.on('disconnected', callback);
@@ -193,7 +193,7 @@ Connection.prototype.collections;
 /**
  * The name of the database this connection points to.
  *
- * #### Example
+ * #### Example:
  *
  *     mongoose.createConnection('mongodb://localhost:27017/mydb').name; // "mydb"
  *
@@ -210,7 +210,7 @@ Connection.prototype.name;
  * a map from model names to models. Contains all models that have been
  * added to this connection using [`Connection#model()`](/docs/api/connection.html#connection_Connection-model).
  *
- * #### Example
+ * #### Example:
  *
  *     const conn = mongoose.createConnection();
  *     const Test = conn.model('Test', mongoose.Schema({ name: String }));
@@ -230,7 +230,7 @@ Connection.prototype.models;
  * A number identifier for this connection. Used for debugging when
  * you have [multiple connections](/docs/connections.html#multiple_connections).
  *
- * #### Example
+ * #### Example:
  *
  *     // The default connection has `id = 0`
  *     mongoose.connection.id; // 0
@@ -274,7 +274,7 @@ Object.defineProperty(Connection.prototype, 'plugins', {
  * The host name portion of the URI. If multiple hosts, such as a replica set,
  * this will contain the first host name in the URI
  *
- * #### Example
+ * #### Example:
  *
  *     mongoose.createConnection('mongodb://localhost:27017/mydb').host; // "localhost"
  *
@@ -294,7 +294,7 @@ Object.defineProperty(Connection.prototype, 'host', {
  * The port portion of the URI. If multiple hosts, such as a replica set,
  * this will contain the port from the first host name in the URI.
  *
- * #### Example
+ * #### Example:
  *
  *     mongoose.createConnection('mongodb://localhost:27017/mydb').port; // 27017
  *
@@ -313,7 +313,7 @@ Object.defineProperty(Connection.prototype, 'port', {
 /**
  * The username specified in the URI
  *
- * #### Example
+ * #### Example:
  *
  *     mongoose.createConnection('mongodb://val:psw@localhost:27017/mydb').user; // "val"
  *
@@ -332,7 +332,7 @@ Object.defineProperty(Connection.prototype, 'user', {
 /**
  * The password specified in the URI
  *
- * #### Example
+ * #### Example:
  *
  *     mongoose.createConnection('mongodb://val:psw@localhost:27017/mydb').pass; // "psw"
  *
@@ -1452,7 +1452,7 @@ Connection.prototype.setClient = function setClient(client) {
  *
  * @param {Object} options
  * @param {Boolean} options.continueOnError `false` by default. If set to `true`, mongoose will not throw an error if one model syncing failed, and will return an object where the keys are the names of the models, and the values are the results/errors for each model.
- * @returns
+ * @return {Promise} Returns a Promise, when the Promise resolves the value is a list of the dropped indexes.
  */
 Connection.prototype.syncIndexes = async function syncIndexes(options = {}) {
   const result = {};

package/lib/cursor/AggregationCursor.js

@@ -107,7 +107,7 @@ if (Symbol.asyncIterator != null) {
  * Registers a transform function which subsequently maps documents retrieved
  * via the streams interface or `.next()`
  *
- * #### Example
+ * #### Example:
  *
  *     // Map documents returned by `data` events
  *     Thing.
@@ -132,6 +132,7 @@ if (Symbol.asyncIterator != null) {
  *
  * @param {Function} fn
  * @return {AggregationCursor}
+ * @memberOf AggregationCursor
  * @api public
  * @method map
  */
@@ -226,7 +227,7 @@ AggregationCursor.prototype.eachAsync = function(fn, opts, callback) {
  * You do not need to call this function explicitly, the JavaScript runtime
  * will call it for you.
  *
- * #### Example
+ * #### Example:
  *
  *     // Async iterator without explicitly calling `cursor()`. Mongoose still
  *     // creates an AggregationCursor instance internally.

package/lib/cursor/QueryCursor.js

@@ -112,7 +112,7 @@ QueryCursor.prototype._read = function() {
  * Registers a transform function which subsequently maps documents retrieved
  * via the streams interface or `.next()`
  *
- * #### Example
+ * #### Example:
  *
  *     // Map documents returned by `data` events
  *     Thing.
@@ -137,6 +137,7 @@ QueryCursor.prototype._read = function() {
  *
  * @param {Function} fn
  * @return {QueryCursor}
+ * @memberOf QueryCursor
  * @api public
  * @method map
  */
@@ -211,7 +212,7 @@ QueryCursor.prototype.next = function(callback) {
  * will wait for the promise to resolve before iterating on to the next one.
  * Returns a promise that resolves when done.
  *
- * #### Example
+ * #### Example:
  *
  *     // Iterate over documents asynchronously
  *     Thing.
@@ -300,7 +301,7 @@ QueryCursor.prototype._transformForAsyncIterator = function() {
  * You do not need to call this function explicitly, the JavaScript runtime
  * will call it for you.
  *
- * #### Example
+ * #### Example:
  *
  *     // Works without using `cursor()`
  *     for await (const doc of Model.find([{ $sort: { name: 1 } }])) {
@@ -320,7 +321,7 @@ QueryCursor.prototype._transformForAsyncIterator = function() {
  * support async iterators.
  *
  * @method Symbol.asyncIterator
- * @memberOf Query
+ * @memberOf QueryCursor
  * @instance
  * @api public
  */

package/lib/document.js

@@ -300,7 +300,35 @@ Object.defineProperty(Document.prototype, '$locals', {
 
 
 /**
- * Boolean flag specifying if the document is new.
+ * Boolean flag specifying if the document is new. If you create a document
+ * using `new`, this document will be considered "new". `$isNew` is how
+ * Mongoose determines whether `save()` should use `insertOne()` to create
+ * a new document or `updateOne()` to update an existing document.
+ *
+ * #### Example:
+ *     const user = new User({ name: 'John Smith' });
+ *     user.$isNew; // true
+ *
+ *     await user.save(); // Sends an `insertOne` to MongoDB
+ *
+ * On the other hand, if you load an existing document from the database
+ * using `findOne()` or another [query operation](/docs/queries.html),
+ * `$isNew` will be false.
+ *
+ * #### Example:
+ *     const user = await User.findOne({ name: 'John Smith' });
+ *     user.$isNew; // false
+ *
+ * For subdocuments, `$isNew` is true if either the parent has `$isNew` set,
+ * or if you create a new subdocument.
+ *
+ * #### Example:
+ *     // Assume `Group` has a document array `users`
+ *     const group = await Group.findOne();
+ *     group.users[0].$isNew; // false
+ *
+ *     group.users.push({ name: 'John Smith' });
+ *     group.users[1].$isNew; // true
  *
  * @api public
  * @property $isNew
@@ -311,7 +339,7 @@ Object.defineProperty(Document.prototype, '$locals', {
 Document.prototype.$isNew;
 
 /**
- * Boolean flag specifying if the document is new.
+ * Legacy alias for `$isNew`.
  *
  * @api public
  * @property isNew
@@ -1722,7 +1750,7 @@ Document.prototype.$__setValue = function(path, val) {
 /**
  * Returns the value of a path.
  *
- * #### Example
+ * #### Example:
  *
  *     // path
  *     doc.get('age') // 47
@@ -1895,7 +1923,7 @@ Document.prototype.$ignore = function(path) {
  * A path `a` may be in `modifiedPaths()` but not in `directModifiedPaths()`
  * because a child of `a` was directly modified.
  *
- * #### Example
+ * #### Example:
  *     const schema = new Schema({ foo: String, nested: { bar: String } });
  *     const Model = mongoose.model('Test', schema);
  *     await Model.create({ foo: 'original', nested: { bar: 'original' } });
@@ -2051,7 +2079,7 @@ Document.prototype[documentModifiedPaths] = Document.prototype.modifiedPaths;
  *
  * If `path` is given, checks if a path or any full path containing `path` as part of its path chain has been modified.
  *
- * #### Example
+ * #### Example:
  *
  *     doc.set('documents.0.title', 'changed');
  *     doc.isModified()                      // true
@@ -2097,7 +2125,7 @@ Document.prototype[documentIsModified] = Document.prototype.isModified;
 /**
  * Checks if a path is set to its default.
  *
- * #### Example
+ * #### Example:
  *
  *     MyModel = mongoose.model('test', { name: { type: String, default: 'Val '} });
  *     const m = new MyModel();
@@ -2161,13 +2189,13 @@ Document.prototype.$isDeleted = function(val) {
 /**
  * Returns true if `path` was directly set and modified, else false.
  *
- * #### Example
+ * #### Example:
  *
  *     doc.set('documents.0.title', 'changed');
  *     doc.isDirectModified('documents.0.title') // true
  *     doc.isDirectModified('documents') // false
  *
- * @param {String|Array<String>} path
+ * @param {String|String[]} path
  * @return {Boolean}
  * @api public
  */
@@ -2217,13 +2245,13 @@ Document.prototype.isInit = function(path) {
 /**
  * Checks if `path` was selected in the source query which initialized this document.
  *
- * #### Example
+ * #### Example:
  *
  *     const doc = await Thing.findOne().select('name');
  *     doc.isSelected('name') // true
  *     doc.isSelected('age')  // false
  *
- * @param {String|Array<String>} path
+ * @param {String|String[]} path
  * @return {Boolean}
  * @api public
  */
@@ -2298,7 +2326,7 @@ Document.prototype.$__isSelected = Document.prototype.isSelected;
  * Checks if `path` was explicitly selected. If no projection, always returns
  * true.
  *
- * #### Example
+ * #### Example:
  *
  *     Thing.findOne().select('nested.name').exec(function (err, doc) {
  *        doc.isDirectSelected('nested.name') // true
@@ -3110,7 +3138,7 @@ function _checkImmutableSubpaths(subdoc, schematype, priorVal) {
 /**
  * Checks if a path is invalid
  *
- * @param {String|Array<String>} path the field to check
+ * @param {String|String[]} path the field to check
  * @method $isValid
  * @memberOf Document
  * @instance
@@ -3640,7 +3668,7 @@ Document.prototype.$toObject = function(options, json) {
  *
  *     schema.set('toObject', { virtuals: true })
  *
- * #### Transform
+ * #### Transform:
  *
  * We may need to perform a transformation of the resulting object based on some criteria, say to remove some sensitive information or return a custom object. In this case we set the optional `transform` function.
  *
@@ -3652,7 +3680,7 @@ Document.prototype.$toObject = function(options, json) {
  * - `ret` The plain object representation which has been converted
  * - `options` The options in use (either schema options or the options passed inline)
  *
- * #### Example
+ * #### Example:
  *
  *     // specify the transform schema option
  *     if (!schema.options.toObject) schema.options.toObject = {};
@@ -4342,7 +4370,7 @@ Document.prototype.$populated = Document.prototype.populated;
  *     doc.$assertPopulated('other path'); // throws an error
  *
  *
- * @param {String|Array<String>} path
+ * @param {String|String[]} path
  * @return {Document} this
  * @memberOf Document
  * @method $assertPopulated

package/lib/error/index.js

@@ -56,7 +56,7 @@ module.exports = exports = MongooseError;
  * @see Error.messages #error_messages_MongooseError-messages
  * @api public
  * @memberOf Error
- * @static messages
+ * @static
  */
 
 MongooseError.messages = require('./messages');
@@ -73,7 +73,7 @@ MongooseError.Messages = MongooseError.messages;
  *
  * @api public
  * @memberOf Error
- * @static DocumentNotFoundError
+ * @static
  */
 
 MongooseError.DocumentNotFoundError = require('./notFound');
@@ -84,7 +84,7 @@ MongooseError.DocumentNotFoundError = require('./notFound');
  *
  * @api public
  * @memberOf Error
- * @static CastError
+ * @static
  */
 
 MongooseError.CastError = require('./cast');
@@ -96,7 +96,7 @@ MongooseError.CastError = require('./cast');
  *
  * @api public
  * @memberOf Error
- * @static ValidationError
+ * @static
  */
 
 MongooseError.ValidationError = require('./validation');
@@ -131,7 +131,7 @@ MongooseError.ValidationError = require('./validation');
  *
  * @api public
  * @memberOf Error
- * @static ValidatorError
+ * @static
  */
 
 MongooseError.ValidatorError = require('./validator');
@@ -143,7 +143,7 @@ MongooseError.ValidatorError = require('./validator');
  *
  * @api public
  * @memberOf Error
- * @static VersionError
+ * @static
  */
 
 MongooseError.VersionError = require('./version');
@@ -155,7 +155,7 @@ MongooseError.VersionError = require('./version');
  *
  * @api public
  * @memberOf Error
- * @static ParallelSaveError
+ * @static
  */
 
 MongooseError.ParallelSaveError = require('./parallelSave');
@@ -166,7 +166,7 @@ MongooseError.ParallelSaveError = require('./parallelSave');
  *
  * @api public
  * @memberOf Error
- * @static OverwriteModelError
+ * @static
  */
 
 MongooseError.OverwriteModelError = require('./overwriteModel');
@@ -176,7 +176,7 @@ MongooseError.OverwriteModelError = require('./overwriteModel');
  *
  * @api public
  * @memberOf Error
- * @static MissingSchemaError
+ * @static
  */
 
 MongooseError.MissingSchemaError = require('./missingSchema');
@@ -187,7 +187,7 @@ MongooseError.MissingSchemaError = require('./missingSchema');
  *
  * @api public
  * @memberOf Error
- * @static MongooseServerSelectionError
+ * @static
  */
 
 MongooseError.MongooseServerSelectionError = require('./serverSelection');
@@ -198,7 +198,7 @@ MongooseError.MongooseServerSelectionError = require('./serverSelection');
  *
  * @api public
  * @memberOf Error
- * @static DivergentArrayError
+ * @static
  */
 
 MongooseError.DivergentArrayError = require('./divergentArray');
@@ -210,7 +210,7 @@ MongooseError.DivergentArrayError = require('./divergentArray');
  *
  * @api public
  * @memberOf Error
- * @static StrictModeError
+ * @static
  */
 
 MongooseError.StrictModeError = require('./strict');

package/lib/error/messages.js

@@ -16,8 +16,8 @@
  *
  * Click the "show code" link below to see all defaults.
  *
- * @static messages
- * @receiver MongooseError
+ * @static
+ * @memberOf MongooseError
  * @api public
  */
 

package/lib/helpers/query/castUpdate.js

@@ -155,12 +155,12 @@ 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} obj part of a query
+ * @param {String} op the atomic operator ($pull, $set, etc)
  * @param {Object} options
  * @param {Boolean|String} [options.strict]
  * @param {Query} context
- * @param {String} pref - path prefix (internal only)
+ * @param {String} pref path prefix (internal only)
  * @return {Bool} true if this path has keys to update
  * @api private
  */
@@ -451,7 +451,7 @@ const overwriteOps = {
  *
  * @param {SchemaType} schema
  * @param {Object} val
- * @param {String} op - the atomic operator ($pull, $set, etc)
+ * @param {String} op the atomic operator ($pull, $set, etc)
  * @param {String} $conditional
  * @param {Query} context
  * @api private

package/lib/index.js

@@ -172,6 +172,7 @@ Mongoose.prototype.setDriver = function setDriver(driver) {
 
   const Connection = driver.getConnection();
   _mongoose.connections = [new Connection(_mongoose)];
+  _mongoose.connections[0].models = _mongoose.models;
 
   return _mongoose;
 };
@@ -761,6 +762,8 @@ Mongoose.prototype.Aggregate = Aggregate;
 /**
  * The Mongoose Collection constructor
  *
+ * @memberOf Mongoose
+ * @instance
  * @method Collection
  * @api public
  */
@@ -799,7 +802,7 @@ Object.defineProperty(Mongoose.prototype, 'Connection', {
 /**
  * The Mongoose version
  *
- * #### Example
+ * #### Example:
  *
  *     console.log(mongoose.version); // '5.x.x'
  *
@@ -1044,7 +1047,7 @@ Mongoose.prototype.isObjectIdOrHexString = function(v) {
  *
  * @param {Object} options
  * @param {Boolean} options.continueOnError `false` by default. If set to `true`, mongoose will not throw an error if one model syncing failed, and will return an object where the keys are the names of the models, and the values are the results/errors for each model.
- * @returns
+ * @return {Promise} Returns a Promise, when the Promise resolves the value is a list of the dropped indexes.
  */
 Mongoose.prototype.syncIndexes = function(options) {
   const _mongoose = this instanceof Mongoose ? this : mongoose;

package/lib/model.js

@@ -212,7 +212,7 @@ Model.prototype.baseModelName;
  * @api public
  * @fires error whenever any query or model function errors
  * @memberOf Model
- * @static events
+ * @static
  */
 
 Model.events;
@@ -899,6 +899,7 @@ Model.prototype.$__version = function(where, delta) {
  *     })
  *
  * @see versionKeys https://mongoosejs.com/docs/guide.html#versionKey
+ * @memberOf Model
  * @api public
  */
 
@@ -1453,7 +1454,7 @@ Model.createCollection = function createCollection(options, callback) {
  * @param {Object} [options] options to pass to `ensureIndexes()`
  * @param {Boolean} [options.background=null] if specified, overrides each index's `background` property
  * @param {Function} [callback] optional callback
- * @return {Promise|undefined} Returns `undefined` if callback is specified, returns a promise if no callback.
+ * @return {Promise|undefined} Returns `undefined` if callback is specified, returns a promise if no callback, when the Promise resolves the value is a list of the dropped indexes.
  * @api public
  */
 
@@ -1821,7 +1822,7 @@ function _ensureIndexes(model, options, callback) {
  * Schema the model uses.
  *
  * @property schema
- * @receiver Model
+ * @static
  * @api public
  * @memberOf Model
  */
@@ -2128,7 +2129,7 @@ Model.deleteMany = function deleteMany(conditions, options, callback) {
  *     await MyModel.find({ name: /john/i }, null, { skip: 10 }).exec();
  *
  * @param {Object|ObjectId} filter
- * @param {Object|String|Array<String>} [projection] optional fields to return, see [`Query.prototype.select()`](https://mongoosejs.com/docs/api.html#query_Query-select)
+ * @param {Object|String|String[]} [projection] optional fields to return, see [`Query.prototype.select()`](https://mongoosejs.com/docs/api.html#query_Query-select)
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api.html#query_Query-setOptions)
  * @param {Function} [callback]
  * @return {Query}
@@ -2191,7 +2192,7 @@ Model.find = function find(conditions, projection, options, callback) {
  *     await Adventure.findById(id, 'name length').exec();
  *
  * @param {Any} id value of `_id` to query by
- * @param {Object|String|Array<String>} [projection] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
+ * @param {Object|String|String[]} [projection] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api.html#query_Query-setOptions)
  * @param {Function} [callback]
  * @return {Query}
@@ -2234,7 +2235,7 @@ Model.findById = function findById(id, projection, options, callback) {
  *     await Adventure.findOne({ country: 'Croatia' }, 'name length').exec();
  *
  * @param {Object} [conditions]
- * @param {Object|String|Array<String>} [projection] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
+ * @param {Object|String|String[]} [projection] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api.html#query_Query-setOptions)
  * @param {Function} [callback]
  * @return {Query}
@@ -2383,7 +2384,7 @@ Model.count = function count(conditions, callback) {
  *
  * Passing a `callback` executes the query.
  *
- * #### Example
+ * #### Example:
  *
  *     Link.distinct('url', { clicks: {$gt: 100}}, function (err, result) {
  *       if (err) return handleError(err);
@@ -2532,7 +2533,7 @@ Model.$where = function $where() {
  * @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 {Boolean} [options.overwrite=false] By default, if you don't include any [update operators](https://docs.mongodb.com/manual/reference/operator/update/) in `update`, Mongoose will wrap `update` in `$set` for you. This prevents you from accidentally overwriting the document. This option tells Mongoose to skip adding `$set`. An alternative to this would be using [Model.findOneAndReplace(conditions, update, options, callback)](https://mongoosejs.com/docs/api/model.html#model_Model.findOneAndReplace).
  * @param {Boolean} [options.upsert=false] if true, and no documents found, insert a new document
- * @param {Object|String|Array<String>} [options.projection=null] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
+ * @param {Object|String|String[]} [options.projection=null] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
  * @param {Function} [callback]
  * @return {Query}
  * @see Tutorial /docs/tutorials/findoneandupdate.html
@@ -2748,7 +2749,7 @@ Model.findByIdAndUpdate = function(id, update, options, callback) {
  * @param {Object} conditions
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api.html#query_Query-setOptions)
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
- * @param {Object|String|Array<String>} [options.projection=null] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
+ * @param {Object|String|String[]} [options.projection=null] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
  * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.html).
  * @param {Function} [callback]
  * @return {Query}
@@ -2854,7 +2855,7 @@ Model.findByIdAndDelete = function(id, options, callback) {
  * @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.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 {Object|String|Array<String>} [options.projection=null] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
+ * @param {Object|String|String[]} [options.projection=null] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
  * @param {Function} [callback]
  * @return {Query}
  * @api public
@@ -2941,7 +2942,7 @@ Model.findOneAndReplace = function(filter, replacement, options, callback) {
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api.html#query_Query-setOptions)
  * @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 {Object|String|Array<String>} [options.projection=null] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
+ * @param {Object|String|String[]} [options.projection=null] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
  * @param {Function} [callback]
  * @return {Query}
  * @see mongodb https://www.mongodb.org/display/DOCS/findAndModify+Command
@@ -3007,7 +3008,7 @@ Model.findOneAndRemove = function(conditions, options, callback) {
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api.html#query_Query-setOptions)
  * @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 {Object|String|Array<String>} [options.projection=null] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
+ * @param {Object|String|String[]} [options.projection=null] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
  * @param {Function} [callback]
  * @return {Query}
  * @see Model.findOneAndRemove #model_Model.findOneAndRemove
@@ -3287,11 +3288,11 @@ Model.startSession = function() {
  *
  * @param {Array|Object|*} doc(s)
  * @param {Object} [options] see the [mongodb driver options](https://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#insertMany)
- * @param {Boolean} [options.ordered = true] if true, will fail fast on the first error encountered. If false, will insert all the documents it can and report errors later. An `insertMany()` with `ordered = false` is called an "unordered" `insertMany()`.
- * @param {Boolean} [options.rawResult = false] if false, the returned promise resolves to the documents that passed mongoose document validation. If `true`, will return the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~insertWriteOpCallback) with a `mongoose` property that contains `validationErrors` if this is an unordered `insertMany`.
- * @param {Boolean} [options.lean = false] if `true`, skips hydrating and validating the documents. This option is useful if you need the extra performance, but Mongoose won't validate the documents before inserting.
- * @param {Number} [options.limit = null] this limits the number of documents being processed (validation/casting) by mongoose in parallel, this does **NOT** send the documents in batches to MongoDB. Use this option if you're processing a large number of documents and your app is running out of memory.
- * @param {String|Object|Array} [options.populate = null] populates the result documents. This option is a no-op if `rawResult` is set.
+ * @param {Boolean} [options.ordered=true] if true, will fail fast on the first error encountered. If false, will insert all the documents it can and report errors later. An `insertMany()` with `ordered = false` is called an "unordered" `insertMany()`.
+ * @param {Boolean} [options.rawResult=false] if false, the returned promise resolves to the documents that passed mongoose document validation. If `true`, will return the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~insertWriteOpCallback) with a `mongoose` property that contains `validationErrors` if this is an unordered `insertMany`.
+ * @param {Boolean} [options.lean=false] if `true`, skips hydrating and validating the documents. This option is useful if you need the extra performance, but Mongoose won't validate the documents before inserting.
+ * @param {Number} [options.limit=null] this limits the number of documents being processed (validation/casting) by mongoose in parallel, this does **NOT** send the documents in batches to MongoDB. Use this option if you're processing a large number of documents and your app is running out of memory.
+ * @param {String|Object|Array} [options.populate=null] populates the result documents. This option is a no-op if `rawResult` is set.
  * @param {Function} [callback] callback
  * @return {Promise} resolving to the raw result from the MongoDB driver if `options.rawResult` was `true`, or the documents that passed validation, otherwise
  * @api public
@@ -3613,7 +3614,7 @@ Model.bulkWrite = function(ops, options, callback) {
  *
  * `bulkSave` uses `bulkWrite` under the hood, so it's mostly useful when dealing with many documents (10K+)
  *
- * @param {[Document]} documents
+ * @param {Array<Document>} documents
  * @param {Object} [options] options passed to the underlying `bulkWrite()`
  * @param {ClientSession} [options.session=null] The session associated with this bulk write. See [transactions docs](/docs/transactions.html).
  * @param {String|number} [options.w=1] The [write concern](https://docs.mongodb.com/manual/reference/write-concern/). See [`Query#w()`](/docs/api.html#query_Query-w) for more information.
@@ -3687,10 +3688,10 @@ function handleSuccessfulWrite(document, resolve, reject) {
 
 /**
  *
- * @param {[Document]} documents The array of documents to build write operations of
+ * @param {Array<Document>} documents The array of documents to build write operations of
  * @param {Object} options
  * @param {Boolean} options.skipValidation defaults to `false`, when set to true, building the write operations will bypass validating the documents.
- * @returns
+ * @return {Array<Promise>} Returns a array of all Promises the function executes to be awaited.
  */
 Model.buildBulkWriteOperations = function buildBulkWriteOperations(documents, options) {
   if (!Array.isArray(documents)) {
@@ -3764,7 +3765,7 @@ Model.buildBulkWriteOperations = function buildBulkWriteOperations(documents, op
  *     const mongooseCandy = Candy.hydrate({ _id: '54108337212ffb6d459f854c', type: 'jelly bean' });
  *
  * @param {Object} obj
- * @param {Object|String|Array<String>} [projection] optional projection containing which fields should be selected for this document
+ * @param {Object|String|String[]} [projection] optional projection containing which fields should be selected for this document
  * @return {Document} document instance
  * @api public
  */