mongoose 6.4.6 → 6.4.7

package/lib/index.js

@@ -191,7 +191,7 @@ Mongoose.prototype.setDriver = function setDriver(driver) {
  * Currently supported options are:
  * - 'applyPluginsToChildSchemas': `true` by default. Set to false to skip applying global plugins to child schemas
  * - 'applyPluginsToDiscriminators': `false` by default. Set to true to apply global plugins to discriminator schemas. This typically isn't necessary because plugins are applied to the base schema and discriminators copy all middleware, methods, statics, and properties from the base schema.
- * - 'autoCreate': Set to `true` to make Mongoose call [`Model.createCollection()`](/docs/api/model.html#model_Model.createCollection) automatically when you create a model with `mongoose.model()` or `conn.model()`. This is useful for testing transactions, change streams, and other features that require the collection to exist.
+ * - 'autoCreate': Set to `true` to make Mongoose call [`Model.createCollection()`](/docs/api/model.html#model_Model-createCollection) automatically when you create a model with `mongoose.model()` or `conn.model()`. This is useful for testing transactions, change streams, and other features that require the collection to exist.
  * - 'autoIndex': `true` by default. Set to false to disable automatic index creation for all models associated with this Mongoose instance.
  * - 'debug': If `true`, prints the operations mongoose sends to MongoDB to the console. If a writable stream is passed, it will log to that stream, without colorization. If a callback function is passed, it will receive the collection name, the method name, then all arguments passed to the method. For example, if you wanted to replicate the default logging, you could output from the callback `Mongoose: ${collectionName}.${methodName}(${methodArgs.join(', ')})`.
  * - 'returnOriginal': If `false`, changes the default `returnOriginal` option to `findOneAndUpdate()`, `findByIdAndUpdate`, and `findOneAndReplace()` to false. This is equivalent to setting the `new` option to `true` for `findOneAndX()` calls by default. Read our [`findOneAndUpdate()` tutorial](/docs/tutorials/findoneandupdate.html) for more information.
@@ -861,7 +861,7 @@ Mongoose.prototype.SchemaType = SchemaType;
  * _Alias of mongoose.Schema.Types for backwards compatibility._
  *
  * @property SchemaTypes
- * @see Schema.SchemaTypes #schema_Schema.Types
+ * @see Schema.SchemaTypes #schema_Schema-Types
  * @api public
  */
 

package/lib/model.js

@@ -2302,7 +2302,7 @@ Model.estimatedDocumentCount = function estimatedDocumentCount(options, callback
  *     });
  *
  * If you want to count all documents in a large collection,
- * use the [`estimatedDocumentCount()` function](/docs/api.html#model_Model.estimatedDocumentCount)
+ * use the [`estimatedDocumentCount()` function](/docs/api.html#model_Model-estimatedDocumentCount)
  * instead. If you call `countDocuments({})`, MongoDB will always execute
  * a full collection scan and **not** use any indexes.
  *
@@ -2347,8 +2347,8 @@ Model.countDocuments = function countDocuments(conditions, options, callback) {
  * Counts number of documents that match `filter` in a database collection.
  *
  * This method is deprecated. If you want to count the number of documents in
- * a collection, e.g. `count({})`, use the [`estimatedDocumentCount()` function](/docs/api.html#model_Model.estimatedDocumentCount)
- * instead. Otherwise, use the [`countDocuments()`](/docs/api.html#model_Model.countDocuments) function instead.
+ * a collection, e.g. `count({})`, use the [`estimatedDocumentCount()` function](/docs/api.html#model_Model-estimatedDocumentCount)
+ * instead. Otherwise, use the [`countDocuments()`](/docs/api.html#model_Model-countDocuments) function instead.
  *
  * #### Example:
  *
@@ -2516,7 +2516,7 @@ Model.$where = function $where() {
  * @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 {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.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|String[]} [options.projection=null] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
  * @param {Boolean} [options.new=false] if true, return the modified document rather than the original
@@ -2647,7 +2647,7 @@ function _decorateUpdateWithVersionKey(update, options, versionKey) {
  * @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 {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({ _id: id }, update, options, callback)](https://mongoosejs.com/docs/api/model.html#model_Model.findOneAndReplace).
+ * @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({ _id: id }, update, options, callback)](https://mongoosejs.com/docs/api/model.html#model_Model-findOneAndReplace).
  * @param {Object|String} [options.sort] if multiple docs are found by the conditions, sets the sort order to choose which doc to update.
  * @param {Boolean} [options.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
  * @param {Boolean} [options.setDefaultsOnInsert=true] 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
@@ -2657,7 +2657,7 @@ function _decorateUpdateWithVersionKey(update, options, versionKey) {
  * @param {Object|String} [options.select] sets the document fields to return.
  * @param {Function} [callback]
  * @return {Query}
- * @see Model.findOneAndUpdate #model_Model.findOneAndUpdate
+ * @see Model.findOneAndUpdate #model_Model-findOneAndUpdate
  * @see mongodb https://www.mongodb.org/display/DOCS/findAndModify+Command
  * @api public
  */
@@ -2778,7 +2778,7 @@ Model.findOneAndDelete = function(conditions, options, callback) {
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {Function} [callback]
  * @return {Query}
- * @see Model.findOneAndRemove #model_Model.findOneAndRemove
+ * @see Model.findOneAndRemove #model_Model-findOneAndRemove
  * @see mongodb https://www.mongodb.org/display/DOCS/findAndModify+Command
  */
 
@@ -2974,7 +2974,7 @@ Model.findOneAndRemove = function(conditions, options, callback) {
  * @param {Object|String} [options.select] sets the document fields to return.
  * @param {Function} [callback]
  * @return {Query}
- * @see Model.findOneAndRemove #model_Model.findOneAndRemove
+ * @see Model.findOneAndRemove #model_Model-findOneAndRemove
  * @see mongodb https://www.mongodb.org/display/DOCS/findAndModify+Command
  */
 
@@ -3054,7 +3054,7 @@ Model.create = function create(doc, options, callback) {
       // to use a spread to specify options, see gh-7535
       utils.warn('WARNING: to pass a `session` to `Model.create()` in ' +
         'Mongoose, you **must** pass an array as the first argument. See: ' +
-        'https://mongoosejs.com/docs/api.html#model_Model.create');
+        'https://mongoosejs.com/docs/api.html#model_Model-create');
     }
   }
 
@@ -3463,7 +3463,7 @@ function _setIsNew(doc, val) {
  *
  * This function does **not** trigger any middleware, neither `save()`, nor `update()`.
  * If you need to trigger
- * `save()` middleware for every document use [`create()`](https://mongoosejs.com/docs/api.html#model_Model.create) instead.
+ * `save()` middleware for every document use [`create()`](https://mongoosejs.com/docs/api.html#model_Model-create) instead.
  *
  * #### Example:
  *

package/lib/query.js

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

package/lib/schema.js

@@ -1698,7 +1698,7 @@ Schema.prototype.post = function(name) {
  *
  * @param {Function} plugin The Plugin's callback
  * @param {Object} [opts] Options to pass to the plugin
- * @see plugins
+ * @see plugins /docs/plugins.html
  * @api public
  */
 

package/lib/schematype.js

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