mongoose 6.2.7 → 6.2.10

package/lib/options/SchemaArrayOptions.js

@@ -5,7 +5,7 @@ const SchemaTypeOptions = require('./SchemaTypeOptions');
 /**
  * The options defined on an Array schematype.
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = new Schema({ tags: [String] });
  *     schema.path('tags').options; // SchemaArrayOptions instance
@@ -36,7 +36,7 @@ Object.defineProperty(SchemaArrayOptions.prototype, 'enum', opts);
  * If set, specifies the type of this array's values. Equivalent to setting
  * `type` to an array whose first element is `of`.
  *
- * ####Example:
+ * #### Example:
  *
  *     // `arr` is an array of numbers.
  *     new Schema({ arr: [Number] });

package/lib/options/SchemaBufferOptions.js

@@ -5,7 +5,7 @@ const SchemaTypeOptions = require('./SchemaTypeOptions');
 /**
  * The options defined on a Buffer schematype.
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = new Schema({ bitmap: Buffer });
  *     schema.path('bitmap').options; // SchemaBufferOptions instance

package/lib/options/SchemaDateOptions.js

@@ -5,7 +5,7 @@ const SchemaTypeOptions = require('./SchemaTypeOptions');
 /**
  * The options defined on a Date schematype.
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = new Schema({ startedAt: Date });
  *     schema.path('startedAt').options; // SchemaDateOptions instance
@@ -48,6 +48,13 @@ Object.defineProperty(SchemaDateOptions.prototype, 'max', opts);
 /**
  * If set, Mongoose creates a TTL index on this path.
  *
+ * mongo TTL index `expireAfterSeconds` value will take 'expires' value expressed in seconds.
+ *
+ * #### Example:
+ *
+ *     const schema = new Schema({ "expireAt": { type: Date,  expires: 11 } });
+ *     // if 'expireAt' is set, then document expires at expireAt + 11 seconds
+ *
  * @api public
  * @property expires
  * @memberOf SchemaDateOptions
@@ -61,4 +68,4 @@ Object.defineProperty(SchemaDateOptions.prototype, 'expires', opts);
  * ignore
  */
 
-module.exports = SchemaDateOptions;
+module.exports = SchemaDateOptions;

package/lib/options/SchemaDocumentArrayOptions.js

@@ -5,7 +5,7 @@ const SchemaTypeOptions = require('./SchemaTypeOptions');
 /**
  * The options defined on an Document Array schematype.
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = new Schema({ users: [{ name: string }] });
  *     schema.path('users').options; // SchemaDocumentArrayOptions instance
@@ -23,7 +23,7 @@ const opts = require('./propertyOptions');
  * If `true`, Mongoose will skip building any indexes defined in this array's schema.
  * If not set, Mongoose will build all indexes defined in this array's schema.
  *
- * ####Example:
+ * #### Example:
  *
  *     const childSchema = Schema({ name: { type: String, index: true } });
  *     // If `excludeIndexes` is `true`, Mongoose will skip building an index
@@ -44,7 +44,7 @@ Object.defineProperty(SchemaDocumentArrayOptions.prototype, 'excludeIndexes', op
 /**
  * If set, overwrites the child schema's `_id` option.
  *
- * ####Example:
+ * #### Example:
  *
  *     const childSchema = Schema({ name: String });
  *     const parentSchema = Schema({

package/lib/options/SchemaMapOptions.js

@@ -5,7 +5,7 @@ const SchemaTypeOptions = require('./SchemaTypeOptions');
 /**
  * The options defined on a Map schematype.
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = new Schema({ socialMediaHandles: { type: Map, of: String } });
  *     schema.path('socialMediaHandles').options; // SchemaMapOptions instance
@@ -25,7 +25,7 @@ const opts = require('./propertyOptions');
  *
  * If not set, Mongoose will not cast the map's values.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Mongoose will cast `socialMediaHandles` values to strings
  *     const schema = new Schema({ socialMediaHandles: { type: Map, of: String } });

package/lib/options/SchemaNumberOptions.js

@@ -5,7 +5,7 @@ const SchemaTypeOptions = require('./SchemaTypeOptions');
 /**
  * The options defined on a Number schematype.
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = new Schema({ count: Number });
  *     schema.path('count').options; // SchemaNumberOptions instance
@@ -49,7 +49,7 @@ Object.defineProperty(SchemaNumberOptions.prototype, 'max', opts);
  * If set, Mongoose adds a validator that checks that this path is strictly
  * equal to one of the given values.
  *
- * ####Example:
+ * #### Example:
  *     const schema = new Schema({
  *       favoritePrime: {
  *         type: Number,
@@ -70,7 +70,7 @@ Object.defineProperty(SchemaNumberOptions.prototype, 'enum', opts);
 /**
  * Sets default [populate options](/docs/populate.html#query-conditions).
  *
- * ####Example:
+ * #### Example:
  *     const schema = new Schema({
  *       child: {
  *         type: Number,

package/lib/options/SchemaObjectIdOptions.js

@@ -5,7 +5,7 @@ const SchemaTypeOptions = require('./SchemaTypeOptions');
 /**
  * The options defined on an ObjectId schematype.
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = new Schema({ testId: mongoose.ObjectId });
  *     schema.path('testId').options; // SchemaObjectIdOptions instance
@@ -34,7 +34,7 @@ Object.defineProperty(SchemaObjectIdOptions.prototype, 'auto', opts);
 /**
  * Sets default [populate options](/docs/populate.html#query-conditions).
  *
- * ####Example:
+ * #### Example:
  *     const schema = new Schema({
  *       child: {
  *         type: 'ObjectId',

package/lib/options/SchemaStringOptions.js

@@ -5,7 +5,7 @@ const SchemaTypeOptions = require('./SchemaTypeOptions');
 /**
  * The options defined on a string schematype.
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = new Schema({ name: String });
  *     schema.path('name').options; // SchemaStringOptions instance

package/lib/options/SchemaSubdocumentOptions.js

@@ -5,7 +5,7 @@ const SchemaTypeOptions = require('./SchemaTypeOptions');
 /**
  * The options defined on a single nested schematype.
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = Schema({ child: Schema({ name: String }) });
  *     schema.path('child').options; // SchemaSubdocumentOptions instance
@@ -22,7 +22,7 @@ const opts = require('./propertyOptions');
 /**
  * If set, overwrites the child schema's `_id` option.
  *
- * ####Example:
+ * #### Example:
  *
  *     const childSchema = Schema({ name: String });
  *     const parentSchema = Schema({

package/lib/options/SchemaTypeOptions.js

@@ -5,7 +5,7 @@ const clone = require('../helpers/clone');
 /**
  * The options defined on a schematype.
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = new Schema({ name: String });
  *     schema.path('name').options instanceof mongoose.SchemaTypeOptions; // true
@@ -53,7 +53,7 @@ Object.defineProperty(SchemaTypeOptions.prototype, 'validate', opts);
  * Allows overriding casting logic for this individual path. If a string, the
  * given string overwrites Mongoose's default cast error message.
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = new Schema({
  *       num: {
@@ -203,7 +203,7 @@ Object.defineProperty(SchemaTypeOptions.prototype, 'text', opts);
  * Define a transform function for this individual schema type.
  * Only called when calling `toJSON()` or `toObject()`.
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = Schema({
  *       myDate: {