mongoose 6.4.1 → 6.4.4

package/lib/helpers/model/applyStaticHooks.js

@@ -68,4 +68,4 @@ module.exports = function applyStaticHooks(model, hooks, statics) {
       };
     }
   }
-};
+};

package/lib/helpers/once.js

@@ -9,4 +9,4 @@ module.exports = function once(fn) {
     called = true;
     return fn.apply(null, arguments);
   };
-};
+};

package/lib/helpers/path/flattenObjectWithDottedPaths.js

@@ -35,4 +35,4 @@ module.exports = function flattenObjectWithDottedPaths(obj) {
 
     flattenObjectWithDottedPaths(obj[key]);
   }
-};
+};

package/lib/helpers/path/parentPaths.js

@@ -15,4 +15,4 @@ module.exports = function parentPaths(path) {
   }
 
   return ret;
-};
+};

package/lib/helpers/path/setDottedPath.js

@@ -30,4 +30,4 @@ module.exports = function setDottedPath(obj, path, val) {
   if (!specialProperties.has(last)) {
     cur[last] = val;
   }
-};
+};

package/lib/helpers/pluralize.js

@@ -91,4 +91,4 @@ function pluralize(str) {
     }
   }
   return str;
-}
+}

package/lib/helpers/populate/SkipPopulateValue.js

@@ -7,4 +7,4 @@ module.exports = function SkipPopulateValue(val) {
 
   this.val = val;
   return this;
-};
+};

package/lib/helpers/populate/assignRawDocsToIdStructure.js

@@ -106,4 +106,4 @@ function assignRawDocsToIdStructure(rawIds, resultDocs, resultOrder, options, re
       rawIds[i] = doc;
     });
   }
-}
+}

package/lib/helpers/populate/assignVals.js

@@ -320,4 +320,4 @@ function isPopulatedObject(obj) {
 
 function noop(v) {
   return v;
-}
+}

package/lib/helpers/populate/createPopulateQueryFilter.js

@@ -77,4 +77,4 @@ function _formatMatch(match) {
     return Object.assign({}, match[0]);
   }
   return Object.assign({}, match);
-}
+}

package/lib/helpers/populate/getModelsMapForPopulate.js

@@ -726,4 +726,4 @@ function _findRefPathForDiscriminators(doc, modelSchema, data, options, normaliz
   }
 
   return modelNames;
-}
+}

package/lib/helpers/populate/leanPopulateMap.js

@@ -4,4 +4,4 @@
  * ignore
  */
 
-module.exports = new WeakMap();
+module.exports = new WeakMap();

package/lib/helpers/populate/lookupLocalFields.js

@@ -37,4 +37,4 @@ module.exports = function lookupLocalFields(cur, path, val) {
   }
 
   return cur[path];
-};
+};

package/lib/helpers/populate/markArraySubdocsPopulated.js

@@ -39,4 +39,4 @@ module.exports = function markArraySubdocsPopulated(doc, populated) {
       }
     }
   }
-};
+};

package/lib/helpers/populate/modelNamesFromRefPath.js

@@ -65,4 +65,4 @@ module.exports = function modelNamesFromRefPath(refPath, doc, populatedPath, mod
   modelNames = utils.array.flatten(modelNames);
 
   return modelNames;
-};
+};

package/lib/helpers/populate/removeDeselectedForeignField.js

@@ -28,4 +28,4 @@ module.exports = function removeDeselectedForeignField(foreignFields, options, d
       }
     }
   }
-};
+};

package/lib/helpers/populate/validateRef.js

@@ -16,4 +16,4 @@ function validateRef(ref, path) {
 
   throw new MongooseError('Invalid ref at path "' + path + '". Got ' +
     util.inspect(ref, { depth: 0 }));
-}
+}

package/lib/helpers/printJestWarning.js

@@ -14,4 +14,4 @@ if (typeof jest !== 'undefined' && process.nextTick.toString().indexOf('nextTick
     'with Jest\'s mock timers enabled. Please make sure you read ' +
     'Mongoose\'s docs on configuring Jest to test Node.js apps: ' +
     'https://mongoosejs.com/docs/jest.html');
-}
+}

package/lib/helpers/processConnectionOptions.js

@@ -9,7 +9,7 @@ function processConnectionOptions(uri, options) {
     ? opts.readPreference
     : getUriReadPreference(uri);
 
-  const resolvedOpts = (readPreference && readPreference !== 'primary')
+  const resolvedOpts = (readPreference && readPreference !== 'primary' && readPreference !== 'primaryPreferred')
     ? resolveOptsConflicts(readPreference, opts)
     : opts;
 

package/lib/helpers/projection/applyProjection.js

@@ -74,4 +74,4 @@ function applyInclusiveProjection(doc, projection, hasIncludedChildren, projecti
     }
   }
   return ret;
-}
+}

package/lib/helpers/projection/hasIncludedChildren.js

@@ -33,4 +33,4 @@ module.exports = function hasIncludedChildren(fields) {
   }
 
   return hasIncludedChildren;
-};
+};

package/lib/helpers/projection/parseProjection.js

@@ -30,4 +30,4 @@ module.exports = function parseProjection(v, retainMinusPaths) {
   }
 
   return ret;
-};
+};

package/lib/helpers/query/applyGlobalOption.js

@@ -26,4 +26,4 @@ function applyGlobalOption(options, model, optionName) {
   } else if (utils.hasUserDefinedProperty(model.base.options, optionName)) {
     options[optionName] = model.base.options[optionName];
   }
-}
+}

package/lib/helpers/query/applyQueryMiddleware.js

@@ -75,4 +75,4 @@ function _getContexts(hook) {
     ret.document = hook.document;
   }
   return ret;
-}
+}

package/lib/helpers/query/cast$expr.js

@@ -279,4 +279,4 @@ function isLiteral(val) {
     return val.$literal != null;
   }
   return true;
-}
+}

package/lib/helpers/query/castFilterPath.js

@@ -51,4 +51,4 @@ module.exports = function castFilterPath(query, schematype, val) {
   }
 
   return val;
-};
+};

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/helpers/query/sanitizeFilter.js

@@ -35,4 +35,4 @@ module.exports = function sanitizeFilter(filter) {
   }
 
   return filter;
-};
+};

package/lib/helpers/query/sanitizeProjection.js

@@ -11,4 +11,4 @@ module.exports = function sanitizeProjection(projection) {
       projection[keys[i]] = 1;
     }
   }
-};
+};

package/lib/helpers/query/trusted.js

@@ -10,4 +10,4 @@ exports.trusted = function trusted(obj) {
   }
   obj[trustedSymbol] = true;
   return obj;
-};
+};

package/lib/helpers/query/validOps.js

@@ -21,4 +21,4 @@ module.exports = Object.freeze([
   'findOneAndDelete',
   'findOneAndRemove',
   'remove'
-]);
+]);

package/lib/helpers/query/wrapThunk.js

@@ -26,4 +26,4 @@ module.exports = function wrapThunk(fn) {
 
     fn.call(this, cb);
   };
-};
+};

package/lib/helpers/schema/addAutoId.js

@@ -4,4 +4,4 @@ module.exports = function addAutoId(schema) {
   const _obj = { _id: { auto: true } };
   _obj._id[schema.options.typeKey] = 'ObjectId';
   schema.add(_obj);
-};
+};

package/lib/helpers/schema/applyPlugins.js

@@ -52,4 +52,4 @@ module.exports = function applyPlugins(schema, plugins, options, cacheKey) {
     applyPlugins(discriminatorSchema, plugins,
       { skipTopLevel: !applyPluginsToDiscriminators }, cacheKey);
   }
-};
+};

package/lib/helpers/schema/cleanPositionalOperators.js

@@ -9,4 +9,4 @@ module.exports = function cleanPositionalOperators(path) {
   return path.
     replace(/\.\$(\[[^\]]*\])?(?=\.)/g, '.0').
     replace(/\.\$(\[[^\]]*\])?$/g, '.0');
-};
+};

package/lib/helpers/schema/getKeysInSchemaOrder.js

@@ -25,4 +25,4 @@ module.exports = function getKeysInSchemaOrder(schema, val, path) {
   }
 
   return keys;
-};
+};

package/lib/helpers/schema/getPath.js

@@ -34,4 +34,4 @@ module.exports = function getPath(schema, path) {
   }
 
   return schematype;
-};
+};

package/lib/helpers/schema/handleIdOption.js

@@ -17,4 +17,4 @@ module.exports = function handleIdOption(schema, options) {
   }
 
   return schema;
-};
+};

package/lib/helpers/schema/handleTimestampOption.js

@@ -21,4 +21,4 @@ function handleTimestampOption(arg, prop) {
     return prop;
   }
   return arg[prop];
-}
+}

package/lib/helpers/specialProperties.js

@@ -1,3 +1,3 @@
 'use strict';
 
-module.exports = new Set(['__proto__', 'constructor', 'prototype']);
+module.exports = new Set(['__proto__', 'constructor', 'prototype']);

package/lib/helpers/symbols.js

@@ -17,4 +17,4 @@ exports.populateModelSymbol = Symbol('mongoose.PopulateOptions#Model');
 exports.schemaTypeSymbol = Symbol('mongoose#schemaType');
 exports.sessionNewDocuments = Symbol('mongoose:ClientSession#newDocuments');
 exports.scopeSymbol = Symbol('mongoose#Document#scope');
-exports.validatorErrorSymbol = Symbol('mongoose:validatorError');
+exports.validatorErrorSymbol = Symbol('mongoose:validatorError');

package/lib/helpers/timers.js

@@ -1,3 +1,3 @@
 'use strict';
 
-exports.setTimeout = setTimeout;
+exports.setTimeout = setTimeout;

package/lib/helpers/timestamps/setupTimestamps.js

@@ -102,4 +102,4 @@ module.exports = function setupTimestamps(schema, timestamps) {
     applyTimestampsToChildren(now, this.getUpdate(), this.model.schema);
     next();
   }
-};
+};

package/lib/helpers/topology/allServersUnknown.js

@@ -9,4 +9,4 @@ module.exports = function allServersUnknown(topologyDescription) {
 
   const servers = Array.from(topologyDescription.servers.values());
   return servers.length > 0 && servers.every(server => server.type === 'Unknown');
-};
+};

package/lib/helpers/topology/isAtlas.js

@@ -23,4 +23,4 @@ module.exports = function isAtlas(topologyDescription) {
     }
   }
   return true;
-};
+};

package/lib/helpers/topology/isSSLError.js

@@ -13,4 +13,4 @@ module.exports = function isSSLError(topologyDescription) {
   const descriptions = Array.from(topologyDescription.servers.values());
   return descriptions.length > 0 &&
     descriptions.every(descr => descr.error && descr.error.message.indexOf(nonSSLMessage) !== -1);
-};
+};

package/lib/helpers/update/applyTimestampsToChildren.js

@@ -186,4 +186,4 @@ function applyTimestampsToUpdateKey(schema, key, update, now) {
       update[key][createdAt] = now;
     }
   }
-}
+}

package/lib/helpers/update/castArrayFilters.js

@@ -80,4 +80,4 @@ function _castArrayFilters(arrayFilters, schema, strictQuery, updatedPathsByFilt
       }
     }
   }
-}
+}

package/lib/helpers/update/moveImmutableProperties.js

@@ -50,4 +50,4 @@ function _walkUpdatePath(schema, op, path, update, ctx) {
   update.$setOnInsert = update.$setOnInsert || {};
   update.$setOnInsert[path] = op[path];
   delete op[path];
-}
+}

package/lib/helpers/update/removeUnusedArrayFilters.js

@@ -29,4 +29,4 @@ function _checkSingleFilterKey(arrayFilter, updateKeys) {
   const arrayFilterKey = firstDot === -1 ? firstKey : firstKey.slice(0, firstDot);
 
   return updateKeys.find(key => key.includes('$[' + arrayFilterKey + ']')) != null;
-}
+}

package/lib/helpers/update/updatedPathsByArrayFilter.js

@@ -24,4 +24,4 @@ module.exports = function updatedPathsByArrayFilter(update) {
     }
     return cur;
   }, {});
-};
+};

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;
@@ -1223,7 +1226,7 @@ Mongoose.prototype._promiseOrCallback = function(callback, fn, ee) {
 /**
  * Use this function in `pre()` middleware to skip calling the wrapped function.
  *
- * ####Example:
+ * #### Example:
  *
  *     schema.pre('save', function() {
  *       // Will skip executing `save()`, but will execute post hooks as if
@@ -1241,7 +1244,7 @@ Mongoose.prototype.skipMiddlewareFunction = Kareem.skipWrappedFunction;
 /**
  * Use this function in `post()` middleware to replace the result
  *
- * ####Example:
+ * #### Example:
  *
  *     schema.post('find', function(res) {
  *       // Normally you have to modify `res` in place. But with

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
  */

package/lib/options/PopulateOptions.js

@@ -33,4 +33,4 @@ class PopulateOptions {
  * @api public
  */
 
-module.exports = PopulateOptions;
+module.exports = PopulateOptions;

package/lib/options/SchemaArrayOptions.js

@@ -26,7 +26,7 @@ const opts = require('./propertyOptions');
  * @api public
  * @property enum
  * @memberOf SchemaArrayOptions
- * @type Array
+ * @type {Array}
  * @instance
  */
 
@@ -46,7 +46,7 @@ Object.defineProperty(SchemaArrayOptions.prototype, 'enum', opts);
  * @api public
  * @property of
  * @memberOf SchemaArrayOptions
- * @type Function|String
+ * @type {Function|String}
  * @instance
  */
 
@@ -56,4 +56,4 @@ Object.defineProperty(SchemaArrayOptions.prototype, 'of', opts);
  * ignore
  */
 
-module.exports = SchemaArrayOptions;
+module.exports = SchemaArrayOptions;