@1791-labs/object-utilities v2.0.3
Project: ObjectUtilities
Some utility functions for JavaScript objects.
Installation
To install ObjectUtilities, run:
npm i --save '@1791-labs/object-utilities'Usage
const ObjectUtilities = require('@1791-labs/object-utilities')API
ObjectUtilities
Kind: global class
- ObjectUtilities
- .createAccessorPropertyDescriptor([getter], [setter]) ⇒ PropertyDescriptor
- .createDataPropertyDescriptor([value], [isWritable]) ⇒ PropertyDescriptor
- .createDescribedFrozenObject([propertyDescriptors]) ⇒ Object
- .createDescribedSealedObject([propertyDescriptors]) ⇒ Object
- .createEmptyObject() ⇒ Object
- .createEnumerableAccessorPropertyDescriptor([getter], [setter]) ⇒ PropertyDescriptor
- .createEnumerableDataPropertyDescriptor([value], [isWritable]) ⇒ PropertyDescriptor
- .createFrozenObject([properties]) ⇒ Object
- .createObject([properties]) ⇒ Object
- .createSealedObject([properties]) ⇒ Object
ObjectUtilities.createAccessorPropertyDescriptor(getter, setter) ⇒ PropertyDescriptor
Kind: static method of ObjectUtilities
Returns: PropertyDescriptor - The accessor property descriptor.
| Param | Type | Description |
|---|---|---|
| getter | function | A function that serves as a getter for the property. |
| setter | function | A function that serves as a setter for the property. |
ObjectUtilities.createDataPropertyDescriptor(value, isWritable) ⇒ PropertyDescriptor
Kind: static method of ObjectUtilities
Returns: PropertyDescriptor - The data property descriptor.
| Param | Type | Description |
|---|---|---|
| value | * | The value associated with the property. |
| isWritable | Boolean | A boolean flag establishing whether or not the property's value may be changed with an assignment operator. |
ObjectUtilities.createDescribedFrozenObject(propertyDescriptors) ⇒ Object
Kind: static method of ObjectUtilities
Returns: Object - The frozen object.
| Param | Type | Description |
|---|---|---|
| propertyDescriptors | Array.<PropertyDescriptor> | A set of property descriptors defining each property of the object. |
ObjectUtilities.createDescribedSealedObject(propertyDescriptors) ⇒ Object
Kind: static method of ObjectUtilities
Returns: Object - The sealed object.
| Param | Type | Description |
|---|---|---|
| propertyDescriptors | Array.<PropertyDescriptor> | A set of property descriptors defining each property of the object. |
ObjectUtilities.createEmptyObject() ⇒ Object
Kind: static method of ObjectUtilities
Returns: Object - The object.
ObjectUtilities.createEnumerableAccessorPropertyDescriptor(getter, setter) ⇒ PropertyDescriptor
Kind: static method of ObjectUtilities
Returns: PropertyDescriptor - The enumerable accessor property descriptor.
| Param | Type | Description |
|---|---|---|
| getter | function | A function that serves as a getter for the property. |
| setter | function | A function that serves as a setter for the property. |
ObjectUtilities.createEnumerableDataPropertyDescriptor(value, isWritable) ⇒ PropertyDescriptor
Kind: static method of ObjectUtilities
Returns: PropertyDescriptor - The enumerable data property descriptor.
| Param | Type | Description |
|---|---|---|
| value | * | The value associated with the property. |
| isWritable | Boolean | A boolean flag establishing whether or not the property's value may be changed with an assignment operator. |
ObjectUtilities.createFrozenObject(properties) ⇒ Object
Kind: static method of ObjectUtilities
Returns: Object - The frozen object.
| Param | Type | Description |
|---|---|---|
| properties | Object | The properties of the object. |
ObjectUtilities.createObject(properties) ⇒ Object
Kind: static method of ObjectUtilities
Returns: Object - The object.
| Param | Type | Description |
|---|---|---|
| properties | Object | The properties of the object. |
ObjectUtilities.createSealedObject(properties) ⇒ Object
Kind: static method of ObjectUtilities
Returns: Object - The sealed object.
| Param | Type | Description |
|---|---|---|
| properties | Object | The properties of the object. |
Author
Jay B. [j@1791.io](mailto:j@1791.io)
License
Apache-2.0, Apache License, Version 2.0