mongoose 9.2.2 → 9.2.4

package/lib/mongoose.js

@@ -56,7 +56,7 @@ const { AsyncLocalStorage } = require('async_hooks');
  *     const m = new mongoose.Mongoose();
  *
  * @api public
- * @param {Object} options see [`Mongoose#set()` docs](https://mongoosejs.com/docs/api/mongoose.html#Mongoose.prototype.set())
+ * @param {object} options see [`Mongoose#set()` docs](https://mongoosejs.com/docs/api/mongoose.html#Mongoose.prototype.set())
  */
 function Mongoose(options) {
   this.connections = [];
@@ -247,9 +247,9 @@ Mongoose.prototype.setDriver = function setDriver(driver) {
  * - `translateAliases`: `false` by default. If `true`, Mongoose will automatically translate aliases to their original paths before sending the query to MongoDB.
  * - `updatePipeline`: `false` by default. If `true`, allows passing update pipelines (arrays) to update operations by default without explicitly setting `updatePipeline: true` in each query.
  *
- * @param {String|Object} key The name of the option or a object of multiple key-value pairs
- * @param {String|Function|Boolean} value The value of the option, unused if "key" is a object
- * @returns {Mongoose} The used Mongoose instnace
+ * @param {string|object} key The name of the option or a object of multiple key-value pairs
+ * @param {string|Function|boolean} value The value of the option, unused if "key" is a object
+ * @returns {Mongoose} The used Mongoose instance
  * @api public
  */
 
@@ -350,7 +350,7 @@ Mongoose.prototype.set = function getsetOptions(key, value) {
  *
  *     mongoose.get('test') // returns the 'test' value
  *
- * @param {String} key
+ * @param {string} key
  * @method get
  * @api public
  */
@@ -385,18 +385,18 @@ Mongoose.prototype.get = Mongoose.prototype.set;
  *     db = mongoose.createConnection();
  *     await db.openUri('mongodb://127.0.0.1:27017/database');
  *
- * @param {String} uri mongodb URI to connect to
- * @param {Object} [options] passed down to the [MongoDB driver's `connect()` function](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/MongoClientOptions.html), except for 4 mongoose-specific options explained below.
- * @param {Boolean} [options.bufferCommands=true] Mongoose specific option. Set to false to [disable buffering](https://mongoosejs.com/docs/faq.html#callback_never_executes) on all models associated with this connection.
- * @param {String} [options.dbName] The name of the database you want to use. If not provided, Mongoose uses the database name from connection string.
- * @param {String} [options.user] username for authentication, equivalent to `options.auth.username`. Maintained for backwards compatibility.
- * @param {String} [options.pass] password for authentication, equivalent to `options.auth.password`. Maintained for backwards compatibility.
- * @param {Boolean} [options.autoIndex=true] Mongoose-specific option. Set to false to disable automatic index creation for all models associated with this connection.
+ * @param {string} uri mongodb URI to connect to
+ * @param {object} [options] passed down to the [MongoDB driver's `connect()` function](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/MongoClientOptions.html), except for 4 mongoose-specific options explained below.
+ * @param {boolean} [options.bufferCommands=true] Mongoose specific option. Set to false to [disable buffering](https://mongoosejs.com/docs/faq.html#callback_never_executes) on all models associated with this connection.
+ * @param {string} [options.dbName] The name of the database you want to use. If not provided, Mongoose uses the database name from connection string.
+ * @param {string} [options.user] username for authentication, equivalent to `options.auth.username`. Maintained for backwards compatibility.
+ * @param {string} [options.pass] password for authentication, equivalent to `options.auth.password`. Maintained for backwards compatibility.
+ * @param {boolean} [options.autoIndex=true] Mongoose-specific option. Set to false to disable automatic index creation for all models associated with this connection.
  * @param {Class} [options.promiseLibrary] Sets the [underlying driver's promise library](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/MongoClientOptions.html#promiseLibrary).
- * @param {Number} [options.maxPoolSize=5] The maximum number of sockets the MongoDB driver will keep open for this connection. Keep in mind that MongoDB only allows one operation per socket at a time, so you may want to increase this if you find you have a few slow queries that are blocking faster queries from proceeding. See [Slow Trains in MongoDB and Node.js](https://thecodebarbarian.com/slow-trains-in-mongodb-and-nodejs).
- * @param {Number} [options.minPoolSize=1] The minimum number of sockets the MongoDB driver will keep open for this connection. Keep in mind that MongoDB only allows one operation per socket at a time, so you may want to increase this if you find you have a few slow queries that are blocking faster queries from proceeding. See [Slow Trains in MongoDB and Node.js](https://thecodebarbarian.com/slow-trains-in-mongodb-and-nodejs).
- * @param {Number} [options.socketTimeoutMS=0] How long the MongoDB driver will wait before killing a socket due to inactivity _after initial connection_. Defaults to 0, which means Node.js will not time out the socket due to inactivity. A socket may be inactive because of either no activity or a long-running operation. This option is passed to [Node.js `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback) after the MongoDB driver successfully completes.
- * @param {Number} [options.family=0] Passed transparently to [Node.js' `dns.lookup()`](https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback) function. May be either `0`, `4`, or `6`. `4` means use IPv4 only, `6` means use IPv6 only, `0` means try both.
+ * @param {number} [options.maxPoolSize=5] The maximum number of sockets the MongoDB driver will keep open for this connection. Keep in mind that MongoDB only allows one operation per socket at a time, so you may want to increase this if you find you have a few slow queries that are blocking faster queries from proceeding. See [Slow Trains in MongoDB and Node.js](https://thecodebarbarian.com/slow-trains-in-mongodb-and-nodejs).
+ * @param {number} [options.minPoolSize=1] The minimum number of sockets the MongoDB driver will keep open for this connection. Keep in mind that MongoDB only allows one operation per socket at a time, so you may want to increase this if you find you have a few slow queries that are blocking faster queries from proceeding. See [Slow Trains in MongoDB and Node.js](https://thecodebarbarian.com/slow-trains-in-mongodb-and-nodejs).
+ * @param {number} [options.socketTimeoutMS=0] How long the MongoDB driver will wait before killing a socket due to inactivity _after initial connection_. Defaults to 0, which means Node.js will not time out the socket due to inactivity. A socket may be inactive because of either no activity or a long-running operation. This option is passed to [Node.js `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback) after the MongoDB driver successfully completes.
+ * @param {number} [options.family=0] Passed transparently to [Node.js' `dns.lookup()`](https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback) function. May be either `0`, `4`, or `6`. `4` means use IPv4 only, `6` means use IPv6 only, `0` means try both.
  * @return {Connection} the created Connection object. Connections are not thenable, so you can't do `await mongoose.createConnection()`. To await use `mongoose.createConnection(uri).asPromise()` instead.
  * @api public
  */
@@ -436,22 +436,22 @@ Mongoose.prototype.createConnection = function createConnection(uri, options) {
  *     const uri = 'mongodb://nonexistent.domain:27000';
  *     await mongoose.connect(uri);
  *
- * @param {String} uri mongodb URI to connect to
- * @param {Object} [options] passed down to the [MongoDB driver's `connect()` function](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/MongoClientOptions.html), except for 4 mongoose-specific options explained below.
- * @param {Boolean} [options.bufferCommands=true] Mongoose specific option. Set to false to [disable buffering](https://mongoosejs.com/docs/faq.html#callback_never_executes) on all models associated with this connection.
- * @param {Number} [options.bufferTimeoutMS=10000] Mongoose specific option. If `bufferCommands` is true, Mongoose will throw an error after `bufferTimeoutMS` if the operation is still buffered.
- * @param {String} [options.dbName] The name of the database we want to use. If not provided, use database name from connection string.
- * @param {String} [options.user] username for authentication, equivalent to `options.auth.username`. Maintained for backwards compatibility.
- * @param {String} [options.pass] password for authentication, equivalent to `options.auth.password`. Maintained for backwards compatibility.
- * @param {Number} [options.maxPoolSize=100] The maximum number of sockets the MongoDB driver will keep open for this connection. Keep in mind that MongoDB only allows one operation per socket at a time, so you may want to increase this if you find you have a few slow queries that are blocking faster queries from proceeding. See [Slow Trains in MongoDB and Node.js](https://thecodebarbarian.com/slow-trains-in-mongodb-and-nodejs).
- * @param {Number} [options.minPoolSize=0] The minimum number of sockets the MongoDB driver will keep open for this connection.
- * @param {Number} [options.serverSelectionTimeoutMS] If `useUnifiedTopology = true`, the MongoDB driver will try to find a server to send any given operation to, and keep retrying for `serverSelectionTimeoutMS` milliseconds before erroring out. If not set, the MongoDB driver defaults to using `30000` (30 seconds).
- * @param {Number} [options.heartbeatFrequencyMS] If `useUnifiedTopology = true`, the MongoDB driver sends a heartbeat every `heartbeatFrequencyMS` to check on the status of the connection. A heartbeat is subject to `serverSelectionTimeoutMS`, so the MongoDB driver will retry failed heartbeats for up to 30 seconds by default. Mongoose only emits a `'disconnected'` event after a heartbeat has failed, so you may want to decrease this setting to reduce the time between when your server goes down and when Mongoose emits `'disconnected'`. We recommend you do **not** set this setting below 1000, too many heartbeats can lead to performance degradation.
- * @param {Boolean} [options.autoIndex=true] Mongoose-specific option. Set to false to disable automatic index creation for all models associated with this connection.
+ * @param {string} uri mongodb URI to connect to
+ * @param {object} [options] passed down to the [MongoDB driver's `connect()` function](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/MongoClientOptions.html), except for 4 mongoose-specific options explained below.
+ * @param {boolean} [options.bufferCommands=true] Mongoose specific option. Set to false to [disable buffering](https://mongoosejs.com/docs/faq.html#callback_never_executes) on all models associated with this connection.
+ * @param {number} [options.bufferTimeoutMS=10000] Mongoose specific option. If `bufferCommands` is true, Mongoose will throw an error after `bufferTimeoutMS` if the operation is still buffered.
+ * @param {string} [options.dbName] The name of the database we want to use. If not provided, use database name from connection string.
+ * @param {string} [options.user] username for authentication, equivalent to `options.auth.username`. Maintained for backwards compatibility.
+ * @param {string} [options.pass] password for authentication, equivalent to `options.auth.password`. Maintained for backwards compatibility.
+ * @param {number} [options.maxPoolSize=100] The maximum number of sockets the MongoDB driver will keep open for this connection. Keep in mind that MongoDB only allows one operation per socket at a time, so you may want to increase this if you find you have a few slow queries that are blocking faster queries from proceeding. See [Slow Trains in MongoDB and Node.js](https://thecodebarbarian.com/slow-trains-in-mongodb-and-nodejs).
+ * @param {number} [options.minPoolSize=0] The minimum number of sockets the MongoDB driver will keep open for this connection.
+ * @param {number} [options.serverSelectionTimeoutMS] If `useUnifiedTopology = true`, the MongoDB driver will try to find a server to send any given operation to, and keep retrying for `serverSelectionTimeoutMS` milliseconds before erroring out. If not set, the MongoDB driver defaults to using `30000` (30 seconds).
+ * @param {number} [options.heartbeatFrequencyMS] If `useUnifiedTopology = true`, the MongoDB driver sends a heartbeat every `heartbeatFrequencyMS` to check on the status of the connection. A heartbeat is subject to `serverSelectionTimeoutMS`, so the MongoDB driver will retry failed heartbeats for up to 30 seconds by default. Mongoose only emits a `'disconnected'` event after a heartbeat has failed, so you may want to decrease this setting to reduce the time between when your server goes down and when Mongoose emits `'disconnected'`. We recommend you do **not** set this setting below 1000, too many heartbeats can lead to performance degradation.
+ * @param {boolean} [options.autoIndex=true] Mongoose-specific option. Set to false to disable automatic index creation for all models associated with this connection.
  * @param {Class} [options.promiseLibrary] Sets the [underlying driver's promise library](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/MongoClientOptions.html#promiseLibrary).
- * @param {Number} [options.socketTimeoutMS=0] How long the MongoDB driver will wait before killing a socket due to inactivity _after initial connection_. A socket may be inactive because of either no activity or a long-running operation. `socketTimeoutMS` defaults to 0, which means Node.js will not time out the socket due to inactivity. This option is passed to [Node.js `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback) after the MongoDB driver successfully completes.
- * @param {Number} [options.family=0] Passed transparently to [Node.js' `dns.lookup()`](https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback) function. May be either `0`, `4`, or `6`. `4` means use IPv4 only, `6` means use IPv6 only, `0` means try both.
- * @param {Boolean} [options.autoCreate=false] Set to `true` to make Mongoose automatically call `createCollection()` on every model created on this connection.
+ * @param {number} [options.socketTimeoutMS=0] How long the MongoDB driver will wait before killing a socket due to inactivity _after initial connection_. A socket may be inactive because of either no activity or a long-running operation. `socketTimeoutMS` defaults to 0, which means Node.js will not time out the socket due to inactivity. This option is passed to [Node.js `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback) after the MongoDB driver successfully completes.
+ * @param {number} [options.family=0] Passed transparently to [Node.js' `dns.lookup()`](https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback) function. May be either `0`, `4`, or `6`. `4` means use IPv4 only, `6` means use IPv6 only, `0` means try both.
+ * @param {boolean} [options.autoCreate=false] Set to `true` to make Mongoose automatically call `createCollection()` on every model created on this connection.
  * @see Mongoose#createConnection https://mongoosejs.com/docs/api/mongoose.html#Mongoose.prototype.createConnection()
  * @api public
  * @return {Promise} resolves to `this` if connection succeeded
@@ -501,8 +501,8 @@ Mongoose.prototype.disconnect = async function disconnect() {
  * Sessions are scoped to a connection, so calling `mongoose.startSession()`
  * starts a session on the [default mongoose connection](https://mongoosejs.com/docs/api/mongoose.html#Mongoose.prototype.connection).
  *
- * @param {Object} [options] see the [mongodb driver options](https://mongodb.github.io/node-mongodb-native/4.9/classes/MongoClient.html#startSession)
- * @param {Boolean} [options.causalConsistency=true] set to false to disable causal consistency
+ * @param {object} [options] see the [mongodb driver options](https://mongodb.github.io/node-mongodb-native/4.9/classes/MongoClient.html#startSession)
+ * @param {boolean} [options.causalConsistency=true] set to false to disable causal consistency
  * @return {Promise<ClientSession>} promise that resolves to a MongoDB driver `ClientSession`
  * @api public
  */
@@ -575,11 +575,11 @@ Mongoose.prototype.pluralize = function pluralize(fn) {
  *     const collectionName = 'actor';
  *     const M = mongoose.model('Actor', schema, collectionName);
  *
- * @param {String|Function} name model name or class extending Model
+ * @param {string|Function} name model name or class extending Model
  * @param {Schema} [schema] the schema to use.
- * @param {String} [collection] name (optional, inferred from model name)
- * @param {Object} [options]
- * @param {Boolean} [options.overwriteModels=false] If true, overwrite existing models with the same name to avoid `OverwriteModelError`
+ * @param {string} [collection] name (optional, inferred from model name)
+ * @param {object} [options]
+ * @param {boolean} [options.overwriteModels=false] If true, overwrite existing models with the same name to avoid `OverwriteModelError`
  * @return {Model} The model associated with `name`. Mongoose will create the model if it doesn't already exist.
  * @api public
  */
@@ -725,7 +725,7 @@ Mongoose.prototype._model = function _model(name, schema, collection, options) {
  *     });
  *
  * @api public
- * @param {String|RegExp} name if string, the name of the model to remove. If regexp, removes all models whose name matches the regexp.
+ * @param {string|RegExp} name if string, the name of the model to remove. If regexp, removes all models whose name matches the regexp.
  * @return {Mongoose} this
  */
 
@@ -779,7 +779,7 @@ Mongoose.prototype._applyPlugins = function _applyPlugins(schema, options) {
  * Equivalent to calling `.plugin(fn)` on each Schema you create.
  *
  * @param {Function} fn plugin callback
- * @param {Object} [opts] optional options
+ * @param {object} [opts] optional options
  * @return {Mongoose} this
  * @see plugins https://mongoosejs.com/docs/plugins.html
  * @api public
@@ -860,7 +860,7 @@ Mongoose.prototype.connections;
  *
  * @memberOf Mongoose
  * @instance
- * @property {Number} nextConnectionId
+ * @property {number} nextConnectionId
  * @api private
  */
 
@@ -1102,7 +1102,7 @@ Mongoose.prototype.ObjectId = SchemaTypes.ObjectId;
  *     mongoose.isValidObjectId({ test: 42 }); // false
  *
  * @method isValidObjectId
- * @param {Any} v
+ * @param {any} v
  * @returns {boolean} true if `v` is something Mongoose can coerce to an ObjectId
  * @api public
  */
@@ -1134,7 +1134,7 @@ Mongoose.prototype.isValidObjectId = function isValidObjectId(v) {
  *     mongoose.isObjectIdOrHexString({ test: 42 }); // false
  *
  * @method isObjectIdOrHexString
- * @param {Any} v
+ * @param {any} v
  * @returns {boolean} true if `v` is an ObjectId instance _or_ a 24 char hex string
  * @api public
  */
@@ -1147,8 +1147,8 @@ Mongoose.prototype.isObjectIdOrHexString = function isObjectIdOrHexString(v) {
  *
  * Syncs all the indexes for the models registered with this connection.
  *
- * @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.
+ * @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.
  * @return {Promise} Returns a Promise, when the Promise resolves the value is a list of the dropped indexes.
  */
 Mongoose.prototype.syncIndexes = function syncIndexes(options) {
@@ -1235,7 +1235,7 @@ Mongoose.prototype.MongooseError = MongooseError;
  * using a tool like [Sinon](https://www.npmjs.com/package/sinon) for testing.
  *
  * @method now
- * @returns Date the current time
+ * @returns {Date} the current time
  * @api public
  */
 
@@ -1245,9 +1245,9 @@ Mongoose.prototype.now = function now() { return new Date(); };
  * The Mongoose CastError constructor
  *
  * @method CastError
- * @param {String} type The name of the type
- * @param {Any} value The value that failed to cast
- * @param {String} path The path `a.b.c` in the doc where this cast error occurred
+ * @param {string} type The name of the type
+ * @param {any} value The value that failed to cast
+ * @param {string} path The path `a.b.c` in the doc where this cast error occurred
  * @param {Error} [reason] The original error that was thrown
  * @api public
  */
@@ -1283,8 +1283,8 @@ Mongoose.prototype.mquery = require('mquery');
  * ```
  *
  * @method sanitizeFilter
- * @param {Object} filter
- * @returns Object the sanitized object
+ * @param {object} filter
+ * @returns {object} the sanitized object
  * @api public
  */
 
@@ -1303,8 +1303,8 @@ Mongoose.prototype.sanitizeFilter = sanitizeFilter;
  * ```
  *
  * @method trusted
- * @param {Object} obj
- * @returns Object the passed in object
+ * @param {object} obj
+ * @returns {object} the passed in object
  * @api public
  */
 
@@ -1399,8 +1399,8 @@ Mongoose.prototype.overwriteMiddlewareArguments = Kareem.overwriteArguments;
  *     await UserModel.findOne(mongoose.omitUndefined(filter));
  *
  * @method omitUndefined
- * @param {Object} [val] the object to remove undefined keys from
- * @returns {Object} the object passed in
+ * @param {object} [val] the object to remove undefined keys from
+ * @returns {object} the object passed in
  * @api public
  */
 

package/lib/options/schemaArrayOptions.js

@@ -46,7 +46,7 @@ Object.defineProperty(SchemaArrayOptions.prototype, 'enum', opts);
  * @api public
  * @property of
  * @memberOf SchemaArrayOptions
- * @type {Function|String}
+ * @type {Function|string}
  * @instance
  */
 
@@ -65,7 +65,7 @@ Object.defineProperty(SchemaArrayOptions.prototype, 'of', opts);
  * @api public
  * @property castNonArrays
  * @memberOf SchemaArrayOptions
- * @type {Boolean}
+ * @type {boolean}
  * @instance
  */
 

package/lib/options/schemaBufferOptions.js

@@ -25,7 +25,7 @@ const opts = require('./propertyOptions');
  * @api public
  * @property subtype
  * @memberOf SchemaBufferOptions
- * @type {Number}
+ * @type {number}
  * @instance
  */
 

package/lib/options/schemaNumberOptions.js

@@ -26,7 +26,7 @@ const opts = require('./propertyOptions');
  * @api public
  * @property min
  * @memberOf SchemaNumberOptions
- * @type {Number}
+ * @type {number}
  * @instance
  */
 
@@ -39,7 +39,7 @@ Object.defineProperty(SchemaNumberOptions.prototype, 'min', opts);
  * @api public
  * @property max
  * @memberOf SchemaNumberOptions
- * @type {Number}
+ * @type {number}
  * @instance
  */
 
@@ -88,7 +88,7 @@ Object.defineProperty(SchemaNumberOptions.prototype, 'enum', opts);
  * @api public
  * @property populate
  * @memberOf SchemaNumberOptions
- * @type {Object}
+ * @type {object}
  * @instance
  */
 

package/lib/options/schemaObjectIdOptions.js

@@ -25,7 +25,7 @@ const opts = require('./propertyOptions');
  * @api public
  * @property auto
  * @memberOf SchemaObjectIdOptions
- * @type {Boolean}
+ * @type {boolean}
  * @instance
  */
 
@@ -51,7 +51,7 @@ Object.defineProperty(SchemaObjectIdOptions.prototype, 'auto', opts);
  * @api public
  * @property populate
  * @memberOf SchemaObjectIdOptions
- * @type {Object}
+ * @type {object}
  * @instance
  */
 

package/lib/options/schemaStringOptions.js

@@ -51,7 +51,7 @@ Object.defineProperty(SchemaStringOptions.prototype, 'match', opts);
  * @api public
  * @property lowercase
  * @memberOf SchemaStringOptions
- * @type {Boolean}
+ * @type {boolean}
  * @instance
  */
 
@@ -64,7 +64,7 @@ Object.defineProperty(SchemaStringOptions.prototype, 'lowercase', opts);
  * @api public
  * @property trim
  * @memberOf SchemaStringOptions
- * @type {Boolean}
+ * @type {boolean}
  * @instance
  */
 
@@ -77,7 +77,7 @@ Object.defineProperty(SchemaStringOptions.prototype, 'trim', opts);
  * @api public
  * @property uppercase
  * @memberOf SchemaStringOptions
- * @type {Boolean}
+ * @type {boolean}
  * @instance
  */
 
@@ -94,7 +94,7 @@ Object.defineProperty(SchemaStringOptions.prototype, 'uppercase', opts);
  * @api public
  * @property minLength
  * @memberOf SchemaStringOptions
- * @type {Number}
+ * @type {number}
  * @instance
  */
 
@@ -112,7 +112,7 @@ Object.defineProperty(SchemaStringOptions.prototype, 'minlength', opts);
  * @api public
  * @property maxLength
  * @memberOf SchemaStringOptions
- * @type {Number}
+ * @type {number}
  * @instance
  */
 
@@ -125,7 +125,7 @@ Object.defineProperty(SchemaStringOptions.prototype, 'maxlength', opts);
  * @api public
  * @property populate
  * @memberOf SchemaStringOptions
- * @type {Object}
+ * @type {object}
  * @instance
  */
 

package/lib/options/schemaTypeOptions.js

@@ -31,7 +31,7 @@ const opts = require('./propertyOptions');
  * @api public
  * @property type
  * @memberOf SchemaTypeOptions
- * @type {Function|String|Object}
+ * @type {Function|string|object}
  * @instance
  */
 
@@ -43,7 +43,7 @@ Object.defineProperty(SchemaTypeOptions.prototype, 'type', opts);
  * @api public
  * @property validate
  * @memberOf SchemaTypeOptions
- * @type {Function|Object}
+ * @type {Function|object}
  * @instance
  */
 
@@ -74,7 +74,7 @@ Object.defineProperty(SchemaTypeOptions.prototype, 'validate', opts);
  * @api public
  * @property cast
  * @memberOf SchemaTypeOptions
- * @type {String}
+ * @type {string}
  * @instance
  */
 
@@ -88,7 +88,7 @@ Object.defineProperty(SchemaTypeOptions.prototype, 'cast', opts);
  * @api public
  * @property required
  * @memberOf SchemaTypeOptions
- * @type {Function|Boolean}
+ * @type {Function|boolean}
  * @instance
  */
 
@@ -101,7 +101,7 @@ Object.defineProperty(SchemaTypeOptions.prototype, 'required', opts);
  * @api public
  * @property default
  * @memberOf SchemaTypeOptions
- * @type {Function|Any}
+ * @type {Function|any}
  * @instance
  */
 
@@ -113,7 +113,7 @@ Object.defineProperty(SchemaTypeOptions.prototype, 'default', opts);
  * @api public
  * @property ref
  * @memberOf SchemaTypeOptions
- * @type {Function|String}
+ * @type {Function|string}
  * @instance
  */
 
@@ -126,7 +126,7 @@ Object.defineProperty(SchemaTypeOptions.prototype, 'ref', opts);
  * @api public
  * @property ref
  * @memberOf SchemaTypeOptions
- * @type {Function|String}
+ * @type {Function|string}
  * @instance
  */
 
@@ -139,7 +139,7 @@ Object.defineProperty(SchemaTypeOptions.prototype, 'refPath', opts);
  * @api public
  * @property select
  * @memberOf SchemaTypeOptions
- * @type {Boolean|Number}
+ * @type {boolean|number}
  * @instance
  */
 
@@ -152,7 +152,7 @@ Object.defineProperty(SchemaTypeOptions.prototype, 'select', opts);
  * @api public
  * @property index
  * @memberOf SchemaTypeOptions
- * @type {Boolean|Number|Object}
+ * @type {boolean|number|object}
  * @instance
  */
 
@@ -166,7 +166,7 @@ Object.defineProperty(SchemaTypeOptions.prototype, 'index', opts);
  * @api public
  * @property unique
  * @memberOf SchemaTypeOptions
- * @type {Boolean|Number}
+ * @type {boolean|number}
  * @instance
  */
 
@@ -180,7 +180,7 @@ Object.defineProperty(SchemaTypeOptions.prototype, 'unique', opts);
  * @api public
  * @property immutable
  * @memberOf SchemaTypeOptions
- * @type {Function|Boolean}
+ * @type {Function|boolean}
  * @instance
  */
 
@@ -193,7 +193,7 @@ Object.defineProperty(SchemaTypeOptions.prototype, 'immutable', opts);
  * @api public
  * @property sparse
  * @memberOf SchemaTypeOptions
- * @type {Boolean|Number}
+ * @type {boolean|number}
  * @instance
  */
 
@@ -206,7 +206,7 @@ Object.defineProperty(SchemaTypeOptions.prototype, 'sparse', opts);
  * @api public
  * @property text
  * @memberOf SchemaTypeOptions
- * @type {Boolean|Number|Object}
+ * @type {boolean|number|object}
  * @instance
  */
 

package/lib/options/virtualOptions.js

@@ -19,7 +19,7 @@ class VirtualOptions {
  * @api public
  * @property ref
  * @memberOf VirtualOptions
- * @type {String|Model|Function}
+ * @type {string|Model|Function}
  * @instance
  */
 
@@ -32,7 +32,7 @@ Object.defineProperty(VirtualOptions.prototype, 'ref', opts);
  * @api public
  * @property refPath
  * @memberOf VirtualOptions
- * @type {String|Function}
+ * @type {string|Function}
  * @instance
  */
 
@@ -45,7 +45,7 @@ Object.defineProperty(VirtualOptions.prototype, 'refPath', opts);
  * @api public
  * @property localField
  * @memberOf VirtualOptions
- * @type {String|Function}
+ * @type {string|Function}
  * @instance
  */
 
@@ -58,7 +58,7 @@ Object.defineProperty(VirtualOptions.prototype, 'localField', opts);
  * @api public
  * @property foreignField
  * @memberOf VirtualOptions
- * @type {String|Function}
+ * @type {string|Function}
  * @instance
  */
 
@@ -71,7 +71,7 @@ Object.defineProperty(VirtualOptions.prototype, 'foreignField', opts);
  * @api public
  * @property justOne
  * @memberOf VirtualOptions
- * @type {Boolean}
+ * @type {boolean}
  * @instance
  */
 
@@ -86,7 +86,7 @@ Object.defineProperty(VirtualOptions.prototype, 'justOne', opts);
  * @api public
  * @property count
  * @memberOf VirtualOptions
- * @type {Boolean}
+ * @type {boolean}
  * @instance
  */
 
@@ -99,7 +99,7 @@ Object.defineProperty(VirtualOptions.prototype, 'count', opts);
  * @api public
  * @property match
  * @memberOf VirtualOptions
- * @type {Object|Function}
+ * @type {object|Function}
  * @instance
  */
 
@@ -115,7 +115,7 @@ Object.defineProperty(VirtualOptions.prototype, 'match', opts);
  * @api public
  * @property options
  * @memberOf VirtualOptions
- * @type {Object}
+ * @type {object}
  * @instance
  */
 
@@ -127,7 +127,7 @@ Object.defineProperty(VirtualOptions.prototype, 'options', opts);
  * @api public
  * @property skip
  * @memberOf VirtualOptions
- * @type {Number}
+ * @type {number}
  * @instance
  */
 
@@ -139,7 +139,7 @@ Object.defineProperty(VirtualOptions.prototype, 'skip', opts);
  * @api public
  * @property limit
  * @memberOf VirtualOptions
- * @type {Number}
+ * @type {number}
  * @instance
  */
 
@@ -155,7 +155,7 @@ Object.defineProperty(VirtualOptions.prototype, 'limit', opts);
  * @api public
  * @property perDocumentLimit
  * @memberOf VirtualOptions
- * @type {Number}
+ * @type {number}
  * @instance
  */