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
|
{{alias}}( obj, properties )
Defines (and/or modifies) object properties.
The second argument is an object whose own enumerable property values are
descriptors for the properties to be defined or modified.
Property descriptors come in two flavors: data descriptors and accessor
descriptors. A data descriptor is a property that has a value, which may or
may not be writable. An accessor descriptor is a property described by a
getter-setter function pair. A descriptor must be one of these two flavors
and cannot be both.
A property descriptor has the following optional properties:
- configurable: boolean indicating if property descriptor can be changed and
if the property can be deleted from the provided object. Default: false.
- enumerable: boolean indicating if the property shows up when enumerating
object properties. Default: false.
- writable: boolean indicating if the value associated with the property can
be changed with an assignment operator. Default: false.
- value: property value.
- get: function which serves as a getter for the property, or, if no getter,
undefined. When the property is accessed, a getter function is called
without arguments and with the `this` context set to the object through
which the property is accessed (which may not be the object on which the
property is defined due to inheritance). The return value will be used as
the property value. Default: undefined.
- set: function which serves as a setter for the property, or, if no setter,
undefined. When assigning a property value, a setter function is called with
one argument (the value being assigned to the property) and with the `this`
context set to the object through which the property is assigned. Default: undefined.
Parameters
----------
obj: Object
Object on which to define the properties.
properties: Object
Object with property descriptors.
Returns
-------
obj: Object
Object on which properties were defined (and/or modified).
Examples
--------
> var obj = {};
> {{alias}}( obj, {
... 'foo': {
... 'value': 'bar',
... 'writable': false,
... 'configurable': false,
... 'enumerable': true
... },
... 'baz': {
... 'value': 13
... }
... });
> obj.foo
'bar'
> obj.baz
13
See Also
--------
|
