boolean.js
4.87 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
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
'use strict';
/*!
* Module dependencies.
*/
const CastError = require('../error/cast');
const SchemaType = require('../schematype');
const castBoolean = require('../cast/boolean');
const utils = require('../utils');
/**
* Boolean SchemaType constructor.
*
* @param {String} path
* @param {Object} options
* @inherits SchemaType
* @api public
*/
function SchemaBoolean(path, options) {
SchemaType.call(this, path, options, 'Boolean');
}
/**
* This schema type's name, to defend against minifiers that mangle
* function names.
*
* @api public
*/
SchemaBoolean.schemaName = 'Boolean';
SchemaBoolean.defaultOptions = {};
/*!
* Inherits from SchemaType.
*/
SchemaBoolean.prototype = Object.create(SchemaType.prototype);
SchemaBoolean.prototype.constructor = SchemaBoolean;
/*!
* ignore
*/
SchemaBoolean._cast = castBoolean;
/**
* Sets a default option for all Boolean instances.
*
* ####Example:
*
* // Make all booleans have `default` of false.
* mongoose.Schema.Boolean.set('default', false);
*
* const Order = mongoose.model('Order', new Schema({ isPaid: Boolean }));
* new Order({ }).isPaid; // false
*
* @param {String} option - The option you'd like to set the value for
* @param {*} value - value for option
* @return {undefined}
* @function set
* @static
* @api public
*/
SchemaBoolean.set = SchemaType.set;
/**
* Get/set the function used to cast arbitrary values to booleans.
*
* ####Example:
*
* // Make Mongoose cast empty string '' to false.
* const original = mongoose.Schema.Boolean.cast();
* mongoose.Schema.Boolean.cast(v => {
* if (v === '') {
* return false;
* }
* return original(v);
* });
*
* // Or disable casting entirely
* mongoose.Schema.Boolean.cast(false);
*
* @param {Function} caster
* @return {Function}
* @function get
* @static
* @api public
*/
SchemaBoolean.cast = function cast(caster) {
if (arguments.length === 0) {
return this._cast;
}
if (caster === false) {
caster = v => {
if (v != null && typeof v !== 'boolean') {
throw new Error();
}
return v;
};
}
this._cast = caster;
return this._cast;
};
/*!
* ignore
*/
SchemaBoolean._checkRequired = v => v === true || v === false;
/**
* Override the function the required validator uses to check whether a boolean
* passes the `required` check.
*
* @param {Function} fn
* @return {Function}
* @function checkRequired
* @static
* @api public
*/
SchemaBoolean.checkRequired = SchemaType.checkRequired;
/**
* Check if the given value satisfies a required validator. For a boolean
* to satisfy a required validator, it must be strictly equal to true or to
* false.
*
* @param {Any} value
* @return {Boolean}
* @api public
*/
SchemaBoolean.prototype.checkRequired = function(value) {
return this.constructor._checkRequired(value);
};
/**
* Configure which values get casted to `true`.
*
* ####Example:
*
* const M = mongoose.model('Test', new Schema({ b: Boolean }));
* new M({ b: 'affirmative' }).b; // undefined
* mongoose.Schema.Boolean.convertToTrue.add('affirmative');
* new M({ b: 'affirmative' }).b; // true
*
* @property convertToTrue
* @type Set
* @api public
*/
Object.defineProperty(SchemaBoolean, 'convertToTrue', {
get: () => castBoolean.convertToTrue,
set: v => { castBoolean.convertToTrue = v; }
});
/**
* Configure which values get casted to `false`.
*
* ####Example:
*
* const M = mongoose.model('Test', new Schema({ b: Boolean }));
* new M({ b: 'nay' }).b; // undefined
* mongoose.Schema.Types.Boolean.convertToFalse.add('nay');
* new M({ b: 'nay' }).b; // false
*
* @property convertToFalse
* @type Set
* @api public
*/
Object.defineProperty(SchemaBoolean, 'convertToFalse', {
get: () => castBoolean.convertToFalse,
set: v => { castBoolean.convertToFalse = v; }
});
/**
* Casts to boolean
*
* @param {Object} value
* @param {Object} model - this value is optional
* @api private
*/
SchemaBoolean.prototype.cast = function(value) {
const castBoolean = typeof this.constructor.cast === 'function' ?
this.constructor.cast() :
SchemaBoolean.cast();
try {
return castBoolean(value);
} catch (error) {
throw new CastError('Boolean', value, this.path, error, this);
}
};
SchemaBoolean.$conditionalHandlers =
utils.options(SchemaType.prototype.$conditionalHandlers, {});
/**
* Casts contents for queries.
*
* @param {String} $conditional
* @param {any} val
* @api private
*/
SchemaBoolean.prototype.castForQuery = function($conditional, val) {
let handler;
if (arguments.length === 2) {
handler = SchemaBoolean.$conditionalHandlers[$conditional];
if (handler) {
return handler.call(this, val);
}
return this._castForQuery(val);
}
return this._castForQuery($conditional);
};
/*!
* Module exports.
*/
module.exports = SchemaBoolean;