deno.land / x / mongoose@6.7.5 / lib / options / SchemaObjectIdOptions.js
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465'use strict';
const SchemaTypeOptions = require('./SchemaTypeOptions');
/** * The options defined on an ObjectId schematype. * * #### Example: * * const schema = new Schema({ testId: mongoose.ObjectId }); * schema.path('testId').options; // SchemaObjectIdOptions instance * * @api public * @inherits SchemaTypeOptions * @constructor SchemaObjectIdOptions */
class SchemaObjectIdOptions extends SchemaTypeOptions {}
const opts = require('./propertyOptions');
/** * If truthy, uses Mongoose's default built-in ObjectId path. * * @api public * @property auto * @memberOf SchemaObjectIdOptions * @type {Boolean} * @instance */
Object.defineProperty(SchemaObjectIdOptions.prototype, 'auto', opts);
/** * Sets default [populate options](/docs/populate.html#query-conditions). * * #### Example: * * const schema = new Schema({ * child: { * type: 'ObjectId', * ref: 'Child', * populate: { select: 'name' } * } * }); * const Parent = mongoose.model('Parent', schema); * * // Automatically adds `.select('name')` * Parent.findOne().populate('child'); * * @api public * @property populate * @memberOf SchemaObjectIdOptions * @type {Object} * @instance */
Object.defineProperty(SchemaObjectIdOptions.prototype, 'populate', opts);
/*! * ignore */
module.exports = SchemaObjectIdOptions;
Version Info