SchemaNumberOptions.js
1.52 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
'use strict';
const SchemaTypeOptions = require('./SchemaTypeOptions');
/**
* The options defined on a Number schematype.
*
* ####Example:
*
* const schema = new Schema({ count: Number });
* schema.path('count').options; // SchemaNumberOptions instance
*
* @api public
* @inherits SchemaTypeOptions
* @constructor SchemaNumberOptions
*/
class SchemaNumberOptions extends SchemaTypeOptions {}
const opts = require('./propertyOptions');
/**
* If set, Mongoose adds a validator that checks that this path is at least the
* given `min`.
*
* @api public
* @property min
* @memberOf SchemaNumberOptions
* @type Number
* @instance
*/
Object.defineProperty(SchemaNumberOptions.prototype, 'min', opts);
/**
* If set, Mongoose adds a validator that checks that this path is less than the
* given `max`.
*
* @api public
* @property max
* @memberOf SchemaNumberOptions
* @type Number
* @instance
*/
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:
* const schema = new Schema({
* favoritePrime: {
* type: Number,
* enum: [3, 5, 7]
* }
* });
* schema.path('favoritePrime').options.enum; // [3, 5, 7]
*
* @api public
* @property enum
* @memberOf SchemaNumberOptions
* @type Array
* @instance
*/
Object.defineProperty(SchemaNumberOptions.prototype, 'enum', opts);
/*!
* ignore
*/
module.exports = SchemaNumberOptions;