SchemaSingleNestedOptions.js
1 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
'use strict';
const SchemaTypeOptions = require('./SchemaTypeOptions');
/**
* The options defined on a single nested schematype.
*
* ####Example:
*
* const schema = Schema({ child: Schema({ name: String }) });
* schema.path('child').options; // SchemaSingleNestedOptions instance
*
* @api public
* @inherits SchemaTypeOptions
* @constructor SchemaSingleNestedOptions
*/
class SchemaSingleNestedOptions extends SchemaTypeOptions {}
const opts = require('./propertyOptions');
/**
* If set, overwrites the child schema's `_id` option.
*
* ####Example:
*
* const childSchema = Schema({ name: String });
* const parentSchema = Schema({
* child: { type: childSchema, _id: false }
* });
* parentSchema.path('child').schema.options._id; // false
*
* @api public
* @property of
* @memberOf SchemaSingleNestedOptions
* @type Function|string
* @instance
*/
Object.defineProperty(SchemaSingleNestedOptions.prototype, '_id', opts);
module.exports = SchemaSingleNestedOptions;