deno.land / x / mongoose@6.7.5 / lib / schema / objectid.js
نووسراو ببینە
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296/*! * Module dependencies. */
'use strict';
const SchemaObjectIdOptions = require('../options/SchemaObjectIdOptions');const SchemaType = require('../schematype');const castObjectId = require('../cast/objectid');const getConstructorName = require('../helpers/getConstructorName');const oid = require('../types/objectid');const isBsonType = require('../helpers/isBsonType');const utils = require('../utils');
const CastError = SchemaType.CastError;let Document;
/** * ObjectId SchemaType constructor. * * @param {String} key * @param {Object} options * @inherits SchemaType * @api public */
function ObjectId(key, options) { const isKeyHexStr = typeof key === 'string' && key.length === 24 && /^[a-f0-9]+$/i.test(key); const suppressWarning = options && options.suppressWarning; if ((isKeyHexStr || typeof key === 'undefined') && !suppressWarning) { utils.warn('mongoose: To create a new ObjectId please try ' + '`Mongoose.Types.ObjectId` instead of using ' + '`Mongoose.Schema.ObjectId`. Set the `suppressWarning` option if ' + 'you\'re trying to create a hex char path in your schema.'); } SchemaType.call(this, key, options, 'ObjectID');}
/** * This schema type's name, to defend against minifiers that mangle * function names. * * @api public */ObjectId.schemaName = 'ObjectId';
ObjectId.defaultOptions = {};
/*! * Inherits from SchemaType. */ObjectId.prototype = Object.create(SchemaType.prototype);ObjectId.prototype.constructor = ObjectId;ObjectId.prototype.OptionsConstructor = SchemaObjectIdOptions;
/** * Attaches a getter for all ObjectId instances * * #### Example: * * // Always convert to string when getting an ObjectId * mongoose.ObjectId.get(v => v.toString()); * * const Model = mongoose.model('Test', new Schema({})); * typeof (new Model({})._id); // 'string' * * @param {Function} getter * @return {this} * @function get * @static * @api public */
ObjectId.get = SchemaType.get;
/** * Sets a default option for all ObjectId instances. * * #### Example: * * // Make all object ids have option `required` equal to true. * mongoose.Schema.ObjectId.set('required', true); * * const Order = mongoose.model('Order', new Schema({ userId: ObjectId })); * new Order({ }).validateSync().errors.userId.message; // Path `userId` is required. * * @param {String} option The option you'd like to set the value for * @param {Any} value value for option * @return {undefined} * @function set * @static * @api public */
ObjectId.set = SchemaType.set;
/** * Adds an auto-generated ObjectId default if turnOn is true. * @param {Boolean} turnOn auto generated ObjectId defaults * @api public * @return {SchemaType} this */
ObjectId.prototype.auto = function(turnOn) { if (turnOn) { this.default(defaultId); this.set(resetId); }
return this;};
/*! * ignore */
ObjectId._checkRequired = v => isBsonType(v, 'ObjectID');
/*! * ignore */
ObjectId._cast = castObjectId;
/** * Get/set the function used to cast arbitrary values to objectids. * * #### Example: * * // Make Mongoose only try to cast length 24 strings. By default, any 12 * // char string is a valid ObjectId. * const original = mongoose.ObjectId.cast(); * mongoose.ObjectId.cast(v => { * assert.ok(typeof v !== 'string' || v.length === 24); * return original(v); * }); * * // Or disable casting entirely * mongoose.ObjectId.cast(false); * * @param {Function} caster * @return {Function} * @function get * @static * @api public */
ObjectId.cast = function cast(caster) { if (arguments.length === 0) { return this._cast; } if (caster === false) { caster = this._defaultCaster; } this._cast = caster;
return this._cast;};
/*! * ignore */
ObjectId._defaultCaster = v => { if (!(isBsonType(v, 'ObjectID'))) { throw new Error(v + ' is not an instance of ObjectId'); } return v;};
/** * Override the function the required validator uses to check whether a string * passes the `required` check. * * #### Example: * * // Allow empty strings to pass `required` check * mongoose.Schema.Types.String.checkRequired(v => v != null); * * const M = mongoose.model({ str: { type: String, required: true } }); * new M({ str: '' }).validateSync(); // `null`, validation passes! * * @param {Function} fn * @return {Function} * @function checkRequired * @static * @api public */
ObjectId.checkRequired = SchemaType.checkRequired;
/** * Check if the given value satisfies a required validator. * * @param {Any} value * @param {Document} doc * @return {Boolean} * @api public */
ObjectId.prototype.checkRequired = function checkRequired(value, doc) { if (SchemaType._isRef(this, value, doc, true)) { return !!value; }
// `require('util').inherits()` does **not** copy static properties, and // plugins like mongoose-float use `inherits()` for pre-ES6. const _checkRequired = typeof this.constructor.checkRequired === 'function' ? this.constructor.checkRequired() : ObjectId.checkRequired();
return _checkRequired(value);};
/** * Casts to ObjectId * * @param {Object} value * @param {Object} doc * @param {Boolean} init whether this is an initialization cast * @api private */
ObjectId.prototype.cast = function(value, doc, init) { if (!(isBsonType(value, 'ObjectID')) && SchemaType._isRef(this, value, doc, init)) { // wait! we may need to cast this to a document if ((getConstructorName(value) || '').toLowerCase() === 'objectid') { return new oid(value.toHexString()); }
if (value == null || utils.isNonBuiltinObject(value)) { return this._castRef(value, doc, init); } }
let castObjectId; if (typeof this._castFunction === 'function') { castObjectId = this._castFunction; } else if (typeof this.constructor.cast === 'function') { castObjectId = this.constructor.cast(); } else { castObjectId = ObjectId.cast(); }
try { return castObjectId(value); } catch (error) { throw new CastError('ObjectId', value, this.path, error, this); }};
/*! * ignore */
function handleSingle(val) { return this.cast(val);}
ObjectId.prototype.$conditionalHandlers = utils.options(SchemaType.prototype.$conditionalHandlers, { $gt: handleSingle, $gte: handleSingle, $lt: handleSingle, $lte: handleSingle });
/*! * ignore */
function defaultId() { return new oid();}
defaultId.$runBeforeSetters = true;
function resetId(v) { Document || (Document = require('./../document'));
if (this instanceof Document) { if (v === void 0) { const _v = new oid(); return _v; } }
return v;}
/*! * Module exports. */
module.exports = ObjectId;
mongoose
Version Info
a year ago
