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
'use strict';
const utils = require('./utils');
/** * VirtualType constructor * * This is what mongoose uses to define virtual attributes via `Schema.prototype.virtual`. * * #### Example: * *     const fullname = schema.virtual('fullname'); *     fullname instanceof mongoose.VirtualType // true * * @param {Object} options * @param {String|Function} [options.ref] if `ref` is not nullish, this becomes a [populated virtual](/docs/populate.html#populate-virtuals) * @param {String|Function} [options.localField] the local field to populate on if this is a populated virtual. * @param {String|Function} [options.foreignField] the foreign field to populate on if this is a populated virtual. * @param {Boolean} [options.justOne=false] by default, a populated virtual is an array. If you set `justOne`, the populated virtual will be a single doc or `null`. * @param {Boolean} [options.getters=false] if you set this to `true`, Mongoose will call any custom getters you defined on this virtual * @param {Boolean} [options.count=false] if you set this to `true`, `populate()` will set this virtual to the number of populated documents, as opposed to the documents themselves, using [`Query#countDocuments()`](./api.html#query_Query-countDocuments) * @param {Object|Function} [options.match=null] add an extra match condition to `populate()` * @param {Number} [options.limit=null] add a default `limit` to the `populate()` query * @param {Number} [options.skip=null] add a default `skip` to the `populate()` query * @param {Number} [options.perDocumentLimit=null] For legacy reasons, `limit` with `populate()` may give incorrect results because it only executes a single query for every document being populated. If you set `perDocumentLimit`, Mongoose will ensure correct `limit` per document by executing a separate query for each document to `populate()`. For example, `.find().populate({ path: 'test', perDocumentLimit: 2 })` will execute 2 additional queries if `.find()` returns 2 documents. * @param {Object} [options.options=null] Additional options like `limit` and `lean`. * @param {String} name * @api public */
function VirtualType(options, name) {  this.path = name;  this.getters = [];  this.setters = [];  this.options = Object.assign({}, options);}
/** * If no getters/setters, add a default * * @api private */
VirtualType.prototype._applyDefaultGetters = function() {  if (this.getters.length > 0 || this.setters.length > 0) {    return;  }
  const path = this.path;  const internalProperty = '$' + path;  this.getters.push(function() {    return this.$locals[internalProperty];  });  this.setters.push(function(v) {    this.$locals[internalProperty] = v;  });};
/*! * ignore */
VirtualType.prototype.clone = function() {  const clone = new VirtualType(this.options, this.path);  clone.getters = [].concat(this.getters);  clone.setters = [].concat(this.setters);  return clone;};
/** * Adds a custom getter to this virtual. * * Mongoose calls the getter function with the below 3 parameters. * * - `value`: the value returned by the previous getter. If there is only one getter, `value` will be `undefined`. * - `virtual`: the virtual object you called `.get()` on. * - `doc`: the document this virtual is attached to. Equivalent to `this`. * * #### Example: * *     const virtual = schema.virtual('fullname'); *     virtual.get(function(value, virtual, doc) { *       return this.name.first + ' ' + this.name.last; *     }); * * @param {Function} fn * @return {VirtualType} this * @api public */
VirtualType.prototype.get = function(fn) {  this.getters.push(fn);  return this;};
/** * Adds a custom setter to this virtual. * * Mongoose calls the setter function with the below 3 parameters. * * - `value`: the value being set. * - `virtual`: the virtual object you're calling `.set()` on. * - `doc`: the document this virtual is attached to. Equivalent to `this`. * * #### Example: * *     const virtual = schema.virtual('fullname'); *     virtual.set(function(value, virtual, doc) { *       const parts = value.split(' '); *       this.name.first = parts[0]; *       this.name.last = parts[1]; *     }); * *     const Model = mongoose.model('Test', schema); *     const doc = new Model(); *     // Calls the setter with `value = 'Jean-Luc Picard'` *     doc.fullname = 'Jean-Luc Picard'; *     doc.name.first; // 'Jean-Luc' *     doc.name.last; // 'Picard' * * @param {Function} fn * @return {VirtualType} this * @api public */
VirtualType.prototype.set = function(fn) {  this.setters.push(fn);  return this;};
/** * Applies getters to `value`. * * @param {Object} value * @param {Document} doc The document this virtual is attached to * @return {Any} the value after applying all getters * @api public */
VirtualType.prototype.applyGetters = function(value, doc) {  if (utils.hasUserDefinedProperty(this.options, ['ref', 'refPath']) &&      doc.$$populatedVirtuals &&      doc.$$populatedVirtuals.hasOwnProperty(this.path)) {    value = doc.$$populatedVirtuals[this.path];  }
  let v = value;  for (const getter of this.getters) {    v = getter.call(doc, v, this, doc);  }  return v;};
/** * Applies setters to `value`. * * @param {Object} value * @param {Document} doc * @return {Any} the value after applying all setters * @api public */
VirtualType.prototype.applySetters = function(value, doc) {  let v = value;  for (const setter of this.setters) {    v = setter.call(doc, v, this, doc);  }  return v;};
/*! * exports */
module.exports = VirtualType;