You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
116 lines
2.5 KiB
116 lines
2.5 KiB
5 years ago
|
'use strict';
|
||
|
|
|
||
|
|
const SchemaTypeOptions = require('./SchemaTypeOptions');
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The options defined on a string schematype.
|
||
|
|
*
|
||
|
|
* ####Example:
|
||
|
|
*
|
||
|
|
* const schema = new Schema({ name: String });
|
||
|
|
* schema.path('name').options; // SchemaStringOptions instance
|
||
|
|
*
|
||
|
|
* @api public
|
||
|
|
* @inherits SchemaTypeOptions
|
||
|
|
* @constructor SchemaStringOptions
|
||
|
|
*/
|
||
|
|
|
||
|
|
class SchemaStringOptions extends SchemaTypeOptions {}
|
||
|
|
|
||
|
|
const opts = require('./propertyOptions');
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Array of allowed values for this path
|
||
|
|
*
|
||
|
|
* @api public
|
||
|
|
* @property enum
|
||
|
|
* @memberOf SchemaStringOptions
|
||
|
|
* @type Array
|
||
|
|
* @instance
|
||
|
|
*/
|
||
|
|
|
||
|
|
Object.defineProperty(SchemaStringOptions.prototype, 'enum', opts);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Attach a validator that succeeds if the data string matches the given regular
|
||
|
|
* expression, and fails otherwise.
|
||
|
|
*
|
||
|
|
* @api public
|
||
|
|
* @property match
|
||
|
|
* @memberOf SchemaStringOptions
|
||
|
|
* @type RegExp
|
||
|
|
* @instance
|
||
|
|
*/
|
||
|
|
|
||
|
|
Object.defineProperty(SchemaStringOptions.prototype, 'match', opts);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* If truthy, Mongoose will add a custom setter that lowercases this string
|
||
|
|
* using JavaScript's built-in `String#toLowerCase()`.
|
||
|
|
*
|
||
|
|
* @api public
|
||
|
|
* @property lowercase
|
||
|
|
* @memberOf SchemaStringOptions
|
||
|
|
* @type Boolean
|
||
|
|
* @instance
|
||
|
|
*/
|
||
|
|
|
||
|
|
Object.defineProperty(SchemaStringOptions.prototype, 'lowercase', opts);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* If truthy, Mongoose will add a custom setter that removes leading and trailing
|
||
|
|
* whitespace using JavaScript's built-in `String#trim()`.
|
||
|
|
*
|
||
|
|
* @api public
|
||
|
|
* @property trim
|
||
|
|
* @memberOf SchemaStringOptions
|
||
|
|
* @type Boolean
|
||
|
|
* @instance
|
||
|
|
*/
|
||
|
|
|
||
|
|
Object.defineProperty(SchemaStringOptions.prototype, 'trim', opts);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* If truthy, Mongoose will add a custom setter that uppercases this string
|
||
|
|
* using JavaScript's built-in `String#toUpperCase()`.
|
||
|
|
*
|
||
|
|
* @api public
|
||
|
|
* @property uppercase
|
||
|
|
* @memberOf SchemaStringOptions
|
||
|
|
* @type Boolean
|
||
|
|
* @instance
|
||
|
|
*/
|
||
|
|
|
||
|
|
Object.defineProperty(SchemaStringOptions.prototype, 'uppercase', opts);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* If set, Mongoose will add a custom validator that ensures the given
|
||
|
|
* string's `length` is at least the given number.
|
||
|
|
*
|
||
|
|
* @api public
|
||
|
|
* @property minlength
|
||
|
|
* @memberOf SchemaStringOptions
|
||
|
|
* @type Number
|
||
|
|
* @instance
|
||
|
|
*/
|
||
|
|
|
||
|
|
Object.defineProperty(SchemaStringOptions.prototype, 'minlength', opts);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* If set, Mongoose will add a custom validator that ensures the given
|
||
|
|
* string's `length` is at most the given number.
|
||
|
|
*
|
||
|
|
* @api public
|
||
|
|
* @property maxlength
|
||
|
|
* @memberOf SchemaStringOptions
|
||
|
|
* @type Number
|
||
|
|
* @instance
|
||
|
|
*/
|
||
|
|
|
||
|
|
Object.defineProperty(SchemaStringOptions.prototype, 'maxlength', opts);
|
||
|
|
|
||
|
|
/*!
|
||
|
|
* ignore
|
||
|
|
*/
|
||
|
|
|
||
|
|
module.exports = SchemaStringOptions;
|