forked from dynamoose/dynamoose
-
Notifications
You must be signed in to change notification settings - Fork 0
/
VirtualType.js
94 lines (80 loc) · 1.82 KB
/
VirtualType.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
'use strict';
const debug = require('debug')('dynamoose:virtualtype');
/**
* VirtualType constructor
*
* This is what mongoose uses to define virtual attributes via `Schema.prototype.virtual`.
*
* ####Example:
*
* let fullname = schema.virtual('fullname');
* fullname instanceof mongoose.VirtualType // true
*
* @parma {Object} options
* @api public
*/
function VirtualType (options, name) {
this.path = name;
this.options = options || {};
}
/**
* Defines a getter.
*
* ####Example:
*
* let virtual = schema.virtual('fullname');
* virtual.get(function () {
* return `${this.name.first} ${this.name.last}`;
* });
*
* @param {Function} fn
* @return {VirtualType} this
* @api public
*/
VirtualType.prototype.get = function (fn) {
debug(`registering getter for ${this.path}`);
this.getter = fn;
return this;
};
/**
* Defines a setter.
*
* ####Example:
*
* let virtual = schema.virtual('fullname');
* virtual.set(function (v) {
* let parts = v.split(' ');
* this.name.first = parts[0];
* this.name.last = parts[1];
* });
*
* @param {Function} fn
* @return {VirtualType} this
* @api public
*/
VirtualType.prototype.set = function (fn) {
debug(`registering setter for ${this.path}`);
this.setter = fn;
return this;
};
/**
* Applies getters and setters to the model
* @param {Object} model
* @return {any} the value after applying all getters
* @api public
*/
VirtualType.prototype.applyVirtuals = function (model) {
debug('applyVirtuals for %s', this.path);
const property = {'enumerable': true, 'configurable': true};
if (this.setter) {
property.set = this.setter;
}
if (this.getter) {
property.get = this.getter;
}
Object.defineProperty(model, this.path, property);
};
/*!
* exports
*/
module.exports = VirtualType;