SchemaArrayOptions.js
1.32 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
'use strict';
const SchemaTypeOptions = require('./SchemaTypeOptions');
/**
* The options defined on an Array schematype.
*
* ####Example:
*
* const schema = new Schema({ tags: [String] });
* schema.path('tags').options; // SchemaArrayOptions instance
*
* @api public
* @inherits SchemaTypeOptions
* @constructor SchemaArrayOptions
*/
class SchemaArrayOptions extends SchemaTypeOptions {}
const opts = require('./propertyOptions');
/**
* If this is an array of strings, an array of allowed values for this path.
* Throws an error if this array isn't an array of strings.
*
* @api public
* @property enum
* @memberOf SchemaArrayOptions
* @type Array
* @instance
*/
Object.defineProperty(SchemaArrayOptions.prototype, 'enum', opts);
/**
* If set, specifies the type of this array's values. Equivalent to setting
* `type` to an array whose first element is `of`.
*
* ####Example:
*
* // `arr` is an array of numbers.
* new Schema({ arr: [Number] });
* // Equivalent way to define `arr` as an array of numbers
* new Schema({ arr: { type: Array, of: Number } });
*
* @api public
* @property of
* @memberOf SchemaArrayOptions
* @type Function|String
* @instance
*/
Object.defineProperty(SchemaArrayOptions.prototype, 'of', opts);
/*!
* ignore
*/
module.exports = SchemaArrayOptions;