/
SchemaTypeOptions.js
172 lines (145 loc) · 4.09 KB
/
SchemaTypeOptions.js
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
'use strict';
const utils = require('../utils');
/**
* The options defined on a schematype.
*
* ####Example:
*
* const schema = new Schema({ name: String });
* schema.path('name').options instanceof mongoose.SchemaTypeOptions; // true
*
* @api public
* @constructor SchemaTypeOptions
*/
class SchemaTypeOptions {
constructor(obj) {
if (obj == null) {
return this;
}
Object.assign(this, utils.clone(obj));
}
}
const opts = require('./propertyOptions');
/**
* The type to cast this path to.
*
* @api public
* @property type
* @memberOf SchemaTypeOptions
* @type Function|String|Object
* @instance
*/
Object.defineProperty(SchemaTypeOptions.prototype, 'type', opts);
/**
* Function or object describing how to validate this schematype.
*
* @api public
* @property validate
* @memberOf SchemaTypeOptions
* @type Function|Object
* @instance
*/
Object.defineProperty(SchemaTypeOptions.prototype, 'validate', opts);
/**
* If true, attach a required validator to this path, which ensures this path
* path cannot be set to a nullish value. If a function, Mongoose calls the
* function and only checks for nullish values if the function returns a truthy value.
*
* @api public
* @property required
* @memberOf SchemaTypeOptions
* @type Function|Boolean
* @instance
*/
Object.defineProperty(SchemaTypeOptions.prototype, 'required', opts);
/**
* The default value for this path. If a function, Mongoose executes the function
* and uses the return value as the default.
*
* @api public
* @property default
* @memberOf SchemaTypeOptions
* @type Function|Any
* @instance
*/
Object.defineProperty(SchemaTypeOptions.prototype, 'default', opts);
/**
* The model that `populate()` should use if populating this path.
*
* @api public
* @property ref
* @memberOf SchemaTypeOptions
* @type Function|String
* @instance
*/
Object.defineProperty(SchemaTypeOptions.prototype, 'ref', opts);
/**
* Whether to include or exclude this path by default when loading documents
* using `find()`, `findOne()`, etc.
*
* @api public
* @property select
* @memberOf SchemaTypeOptions
* @type Boolean|Number
* @instance
*/
Object.defineProperty(SchemaTypeOptions.prototype, 'select', opts);
/**
* If [truthy](https://masteringjs.io/tutorials/fundamentals/truthy), Mongoose will
* build an index on this path when the model is
* compiled.
*
* @api public
* @property index
* @memberOf SchemaTypeOptions
* @type Boolean|Number|Object
* @instance
*/
Object.defineProperty(SchemaTypeOptions.prototype, 'index', opts);
/**
* If [truthy](https://masteringjs.io/tutorials/fundamentals/truthy), Mongoose
* will build a unique index on this path when the
* model is compiled. [The `unique` option is **not** a validator](/docs/validation.html#the-unique-option-is-not-a-validator).
*
* @api public
* @property unique
* @memberOf SchemaTypeOptions
* @type Boolean|Number
* @instance
*/
Object.defineProperty(SchemaTypeOptions.prototype, 'unique', opts);
/**
* If [truthy](https://masteringjs.io/tutorials/fundamentals/truthy), Mongoose will
* disallow changes to this path once the document
* is saved to the database for the first time. Read more about [immutability in Mongoose here](http://thecodebarbarian.com/whats-new-in-mongoose-5-6-immutable-properties.html).
*
* @api public
* @property immutable
* @memberOf SchemaTypeOptions
* @type Function|Boolean
* @instance
*/
Object.defineProperty(SchemaTypeOptions.prototype, 'immutable', opts);
/**
* If [truthy](https://masteringjs.io/tutorials/fundamentals/truthy), Mongoose will
* build a sparse index on this path.
*
* @api public
* @property sparse
* @memberOf SchemaTypeOptions
* @type Boolean|Number
* @instance
*/
Object.defineProperty(SchemaTypeOptions.prototype, 'sparse', opts);
/**
* If [truthy](https://masteringjs.io/tutorials/fundamentals/truthy), Mongoose
* will build a text index on this path.
*
* @api public
* @property text
* @memberOf SchemaTypeOptions
* @type Boolean|Number|Object
* @instance
*/
Object.defineProperty(SchemaTypeOptions.prototype, 'text', opts);
module.exports = SchemaTypeOptions;