mongoose 6.2.9 → 6.2.10

package/lib/document.js

@@ -268,7 +268,7 @@ Document.prototype.schema;
  * is handy for passing data to middleware without conflicting with Mongoose
  * internals.
  *
- * ####Example:
+ * #### Example:
  *
  *     schema.pre('save', function() {
  *       // Mongoose will set `isNew` to `false` if `save()` succeeds
@@ -326,7 +326,7 @@ Document.prototype.isNew;
 /**
  * Set this property to add additional query filters when Mongoose saves this document and `isNew` is false.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Make sure `save()` never updates a soft deleted document.
  *     schema.pre('save', function() {
@@ -348,7 +348,7 @@ Object.defineProperty(Document.prototype, '$where', {
 /**
  * The string version of this documents _id.
  *
- * ####Note:
+ * #### Note:
  *
  * This getter exists on all documents by default. The getter can be disabled by setting the `id` [option](/docs/guide.html#id) of its `Schema` to false at construction time.
  *
@@ -389,7 +389,7 @@ Document.prototype.errors;
  * A string containing the current operation that Mongoose is executing
  * on this document. May be `null`, `'save'`, `'validate'`, or `'remove'`.
  *
- * ####Example:
+ * #### Example:
  *
  *     const doc = new Model({ name: 'test' });
  *     doc.$op; // null
@@ -841,11 +841,11 @@ function init(self, obj, doc, opts, prefix) {
 /**
  * Sends an update command with this document `_id` as the query selector.
  *
- * ####Example:
+ * #### Example:
  *
  *     weirdCar.update({$inc: {wheels:1}}, { w: 1 }, callback);
  *
- * ####Valid options:
+ * #### Valid options:
  *
  *  - same as in [Model.update](#model_Model.update)
  *
@@ -876,11 +876,11 @@ Document.prototype.update = function update() {
 /**
  * Sends an updateOne command with this document `_id` as the query selector.
  *
- * ####Example:
+ * #### Example:
  *
  *     weirdCar.updateOne({$inc: {wheels:1}}, { w: 1 }, callback);
  *
- * ####Valid options:
+ * #### Valid options:
  *
  *  - same as in [Model.updateOne](#model_Model.updateOne)
  *
@@ -922,7 +922,7 @@ Document.prototype.updateOne = function updateOne(doc, options, callback) {
 /**
  * Sends a replaceOne command with this document `_id` as the query selector.
  *
- * ####Valid options:
+ * #### Valid options:
  *
  *  - same as in [Model.replaceOne](https://mongoosejs.com/docs/api/model.html#model_Model.replaceOne)
  *
@@ -947,7 +947,7 @@ Document.prototype.replaceOne = function replaceOne() {
  * automatically set `session` if you `save()` a doc that you got from a
  * query with an associated session.
  *
- * ####Example:
+ * #### Example:
  *
  *     const session = MyModel.startSession();
  *     const doc = await MyModel.findOne().session(session);
@@ -1514,7 +1514,7 @@ function _isManuallyPopulatedArray(val, ref) {
 /**
  * Sets the value of a path, or many paths.
  *
- * ####Example:
+ * #### Example:
  *
  *     // path, value
  *     doc.set(path, value)
@@ -1718,7 +1718,7 @@ Document.prototype.$__setValue = function(path, val) {
 /**
  * Returns the value of a path.
  *
- * ####Example
+ * #### Example
  *
  *     // path
  *     doc.get('age') // 47
@@ -1824,7 +1824,7 @@ Document.prototype.$__path = function(path) {
  *
  * _Very helpful when using [Mixed](https://mongoosejs.com/docs/schematypes.html#mixed) types._
  *
- * ####Example:
+ * #### Example:
  *
  *     doc.mixed.type = 'changed';
  *     doc.markModified('mixed.type');
@@ -1847,7 +1847,7 @@ Document.prototype.markModified = function(path, scope) {
 /**
  * Clears the modified state on the specified path.
  *
- * ####Example:
+ * #### Example:
  *
  *     doc.foo = 'bar';
  *     doc.unmarkModified('foo');
@@ -1867,7 +1867,7 @@ Document.prototype.unmarkModified = function(path) {
 /**
  * Don't run validation on this path or persist changes to this path.
  *
- * ####Example:
+ * #### Example:
  *
  *     doc.foo = null;
  *     doc.$ignore('foo');
@@ -1892,7 +1892,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' } });
@@ -1915,7 +1915,7 @@ Document.prototype.directModifiedPaths = function() {
  * Useful for determining whether this subdoc will get stripped out by the
  * [minimize option](/docs/guide.html#minimize).
  *
- * ####Example:
+ * #### Example:
  *     const schema = new Schema({ nested: { foo: String } });
  *     const Model = mongoose.model('Test', schema);
  *     const doc = new Model({});
@@ -2048,7 +2048,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
@@ -2094,7 +2094,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();
@@ -2128,7 +2128,7 @@ Document.prototype.$isDefault = function(path) {
 /**
  * Getter/setter, determines whether the document was removed or not.
  *
- * ####Example:
+ * #### Example:
  *     const product = await product.remove();
  *     product.$isDeleted(); // true
  *     product.remove(); // no-op, doesn't send anything to the db
@@ -2158,7 +2158,7 @@ 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
@@ -2214,7 +2214,7 @@ 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
@@ -2295,7 +2295,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
@@ -2357,11 +2357,11 @@ Document.prototype.isDirectSelected = function isDirectSelected(path) {
 /**
  * Executes registered validation rules for this document.
  *
- * ####Note:
+ * #### Note:
  *
  * This method is called `pre` save and if a validation rule is violated, [save](#model_Model-save) is aborted and the error is returned to your `callback`.
  *
- * ####Example:
+ * #### Example:
  *
  *     doc.validate(function (err) {
  *       if (err) handleError(err);
@@ -2826,11 +2826,11 @@ function _handlePathsToSkip(paths, pathsToSkip) {
 /**
  * Executes registered validation rules (skipping asynchronous validators) for this document.
  *
- * ####Note:
+ * #### Note:
  *
  * This method is useful if you need synchronous validation.
  *
- * ####Example:
+ * #### Example:
  *
  *     const err = doc.validateSync();
  *     if (err) {
@@ -3065,7 +3065,7 @@ function _checkImmutableSubpaths(subdoc, schematype, priorVal) {
  * Saves this document by inserting a new document into the database if [document.isNew](/docs/api.html#document_Document-isNew) is `true`,
  * or sends an [updateOne](/docs/api.html#document_Document-updateOne) operation **only** with the modifications to the database, it does not replace the whole document in the latter case.
  *
- * ####Example:
+ * #### Example:
  *
  *     product.sold = Date.now();
  *     product = await product.save();
@@ -3073,7 +3073,7 @@ function _checkImmutableSubpaths(subdoc, schematype, priorVal) {
  * If save is successful, the returned promise will fulfill with the document
  * saved.
  *
- * ####Example:
+ * #### Example:
  *
  *     const newProduct = await product.save();
  *     newProduct === product; // true
@@ -3601,7 +3601,7 @@ Document.prototype.$toObject = function(options, json) {
  *
  * Buffers are converted to instances of [mongodb.Binary](https://mongodb.github.com/node-mongodb-native/api-bson-generated/binary.html) for proper storage.
  *
- * ####Options:
+ * #### Options:
  *
  * - `getters` apply all getters (path and virtual getters), defaults to false
  * - `aliases` apply all aliases if `virtuals=true`, defaults to true
@@ -3613,7 +3613,7 @@ Document.prototype.$toObject = function(options, json) {
  * - `flattenMaps` convert Maps to POJOs. Useful if you want to JSON.stringify() the result of toObject(), defaults to false
  * - `useProjection` set to `true` to omit 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.
  *
- * ####Getters/Virtuals
+ * #### Getters/Virtuals
  *
  * Example of only applying path getters
  *
@@ -3631,7 +3631,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.
  *
@@ -3643,7 +3643,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 = {};
@@ -4137,7 +4137,7 @@ Document.prototype.equals = function(doc) {
 /**
  * Populates paths on an existing document.
  *
- * ####Example:
+ * #### Example:
  *
  *     await doc.populate([
  *       'stories',
@@ -4254,7 +4254,7 @@ Document.prototype.$getPopulatedDocs = function $getPopulatedDocs() {
 /**
  * Gets _id(s) used during population of the given `path`.
  *
- * ####Example:
+ * #### Example:
  *
  *     Model.findOne().populate('author').exec(function (err, doc) {
  *       console.log(doc.author.name)         // Dr.Seuss
@@ -4316,7 +4316,7 @@ Document.prototype.$populated = Document.prototype.populated;
 /**
  * Takes a populated field and returns it to its unpopulated state.
  *
- * ####Example:
+ * #### Example:
  *
  *     Model.findOne().populate('author').exec(function (err, doc) {
  *       console.log(doc.author.name); // Dr.Seuss

package/lib/error/index.js

@@ -4,7 +4,7 @@
  * MongooseError constructor. MongooseError is the base class for all
  * Mongoose-specific errors.
  *
- * ####Example:
+ * #### Example:
  *     const Model = mongoose.model('Test', new Schema({ answer: Number }));
  *     const doc = new Model({ answer: 'not a number' });
  *     const err = doc.validateSync();
@@ -105,7 +105,7 @@ MongooseError.ValidationError = require('./validation');
  * A `ValidationError` has a hash of `errors` that contain individual
  * `ValidatorError` instances.
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = Schema({ name: { type: String, required: true } });
  *     const Model = mongoose.model('Test', schema);

package/lib/helpers/populate/markArraySubdocsPopulated.js

@@ -6,7 +6,7 @@ const utils = require('../../utils');
  * If populating a path within a document array, make sure each
  * subdoc within the array knows its subpaths are populated.
  *
- * ####Example:
+ * #### Example:
  *     const doc = await Article.findOne().populate('comments.author');
  *     doc.comments[0].populated('author'); // Should be set
  */

package/lib/helpers/projection/hasIncludedChildren.js

@@ -4,7 +4,7 @@
  * Creates an object that precomputes whether a given path has child fields in
  * the projection.
  *
- * ####Example:
+ * #### Example:
  *     const res = hasIncludedChildren({ 'a.b.c': 0 });
  *     res.a; // 1
  *     res['a.b']; // 1

package/lib/index.js

@@ -47,7 +47,7 @@ const objectIdHexRegexp = /^[0-9A-Fa-f]{24}$/;
  * The exports object of the `mongoose` module is an instance of this class.
  * Most apps will only use this one instance.
  *
- * ####Example:
+ * #### Example:
  *     const mongoose = require('mongoose');
  *     mongoose instanceof mongoose.Mongoose; // true
  *
@@ -144,7 +144,7 @@ Mongoose.prototype.driver = driver;
 /**
  * Sets mongoose options
  *
- * ####Example:
+ * #### Example:
  *
  *     mongoose.set('test', value) // sets the 'test' option to `value`
  *
@@ -207,7 +207,7 @@ Mongoose.prototype.set = function(key, value) {
 /**
  * Gets mongoose options
  *
- * ####Example:
+ * #### Example:
  *
  *     mongoose.get('test') // returns the 'test' value
  *
@@ -226,7 +226,7 @@ Mongoose.prototype.get = Mongoose.prototype.set;
  *
  * _Options passed take precedence over options included in connection strings._
  *
- * ####Example:
+ * #### Example:
  *
  *     // with mongodb:// URI
  *     db = mongoose.createConnection('mongodb://user:pass@localhost:port/database');
@@ -290,7 +290,7 @@ Mongoose.prototype.createConnection = function(uri, options, callback) {
 /**
  * Opens the default mongoose connection.
  *
- * ####Example:
+ * #### Example:
  *
  *     mongoose.connect('mongodb://user:pass@localhost:port/database');
  *
@@ -424,7 +424,7 @@ Mongoose.prototype.pluralize = function(fn) {
  * you will get an `OverwriteModelError`. If you call `mongoose.model()` with
  * the same name and same schema, you'll get the same schema back.
  *
- * ####Example:
+ * #### Example:
  *
  *     const mongoose = require('mongoose');
  *
@@ -446,7 +446,7 @@ Mongoose.prototype.pluralize = function(fn) {
  *
  * _When no `collection` argument is passed, Mongoose uses the model name. If you don't like this behavior, either pass a collection name, use `mongoose.pluralize()`, or set your schemas collection name option._
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = new Schema({ name: String }, { collection: 'actor' });
  *
@@ -577,7 +577,7 @@ Mongoose.prototype._model = function(name, schema, collection, options) {
  *
  * Equivalent to `mongoose.connection.deleteModel(name)`.
  *
- * ####Example:
+ * #### Example:
  *
  *     mongoose.model('User', new Schema({ name: String }));
  *     console.log(mongoose.model('User')); // Model object
@@ -605,7 +605,7 @@ Mongoose.prototype.deleteModel = function(name) {
 /**
  * Returns an array of model names created on this instance of Mongoose.
  *
- * ####Note:
+ * #### Note:
  *
  * _Does not include names of models created using `connection.model()`._
  *
@@ -658,7 +658,7 @@ Mongoose.prototype.plugin = function(fn, opts) {
 /**
  * The Mongoose module's default connection. Equivalent to `mongoose.connections[0]`, see [`connections`](#mongoose_Mongoose-connections).
  *
- * ####Example:
+ * #### Example:
  *
  *     const mongoose = require('mongoose');
  *     mongoose.connect(...);
@@ -691,7 +691,7 @@ Mongoose.prototype.__defineSetter__('connection', function(v) {
  * [`createConnection()`](#mongoose_Mongoose-createConnection) adds a connection
  * to this array.
  *
- * ####Example:
+ * #### Example:
  *
  *     const mongoose = require('mongoose');
  *     mongoose.connections.length; // 1, just the default connection
@@ -767,7 +767,7 @@ Mongoose.prototype.version = pkg.version;
  *
  * The exports of the mongoose module is an instance of this class.
  *
- * ####Example:
+ * #### Example:
  *
  *     const mongoose = require('mongoose');
  *     const mongoose2 = new mongoose.Mongoose();
@@ -781,7 +781,7 @@ Mongoose.prototype.Mongoose = Mongoose;
 /**
  * The Mongoose [Schema](#schema_Schema) constructor
  *
- * ####Example:
+ * #### Example:
  *
  *     const mongoose = require('mongoose');
  *     const Schema = mongoose.Schema;
@@ -805,7 +805,7 @@ Mongoose.prototype.SchemaType = SchemaType;
 /**
  * The various Mongoose SchemaTypes.
  *
- * ####Note:
+ * #### Note:
  *
  * _Alias of mongoose.Schema.Types for backwards compatibility._
  *
@@ -828,12 +828,12 @@ Mongoose.prototype.VirtualType = VirtualType;
 /**
  * The various Mongoose Types.
  *
- * ####Example:
+ * #### Example:
  *
  *     const mongoose = require('mongoose');
  *     const array = mongoose.Types.Array;
  *
- * ####Types:
+ * #### Types:
  *
  * - [Array](/docs/schematypes.html#arrays)
  * - [Buffer](/docs/schematypes.html#buffers)
@@ -926,7 +926,7 @@ Mongoose.prototype.DocumentProvider = require('./document_provider');
  * Do not use this to create a new ObjectId instance, use `mongoose.Types.ObjectId`
  * instead.
  *
- * ####Example:
+ * #### Example:
  *
  *     const childSchema = new Schema({ parentId: mongoose.ObjectId });
  *
@@ -940,7 +940,7 @@ Mongoose.prototype.ObjectId = SchemaTypes.ObjectId;
  * Returns true if Mongoose can cast the given value to an ObjectId, or
  * false otherwise.
  *
- * ####Example:
+ * #### Example:
  *
  *     mongoose.isValidObjectId(new mongoose.Types.ObjectId()); // true
  *     mongoose.isValidObjectId('0123456789ab'); // true
@@ -971,7 +971,7 @@ Mongoose.prototype.isValidObjectId = function(v) {
  * `isObjectIdOrHexString()` returns true only for `ObjectId` instances or 24 character hex
  * strings, and will return false for numbers, documents, and strings of length 12.
  *
- * ####Example:
+ * #### Example:
  *
  *     mongoose.isObjectIdOrHexString(new mongoose.Types.ObjectId()); // true
  *     mongoose.isObjectIdOrHexString('62261a65d66c6be0a63c051f'); // true
@@ -1012,7 +1012,7 @@ Mongoose.prototype.syncIndexes = function(options) {
  * Do not use this to create a new Decimal128 instance, use `mongoose.Types.Decimal128`
  * instead.
  *
- * ####Example:
+ * #### Example:
  *
  *     const vehicleSchema = new Schema({ fuelLevel: mongoose.Decimal128 });
  *
@@ -1027,7 +1027,7 @@ Mongoose.prototype.Decimal128 = SchemaTypes.Decimal128;
  * declaring paths in your schema that Mongoose's change tracking, casting,
  * and validation should ignore.
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = new Schema({ arbitrary: mongoose.Mixed });
  *
@@ -1040,7 +1040,7 @@ Mongoose.prototype.Mixed = SchemaTypes.Mixed;
 /**
  * The Mongoose Date [SchemaType](/docs/schematypes.html).
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = new Schema({ test: Date });
  *     schema.path('test') instanceof mongoose.Date; // true
@@ -1055,7 +1055,7 @@ Mongoose.prototype.Date = SchemaTypes.Date;
  * The Mongoose Number [SchemaType](/docs/schematypes.html). Used for
  * declaring paths in your schema that Mongoose should cast to numbers.
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = new Schema({ num: mongoose.Number });
  *     // Equivalent to: