@1791-labs/object-utilities 中文文档教程

Question

Project: ObjectUtilities

JavaScript 对象的一些实用函数。

Installation

安装 ObjectUtilities，运行：

npm i --save '@1791-labs/object-utilities'

Usage

const ObjectUtilities = require('@1791-labs/object-utilities')

API

ObjectUtilities

JavaScript 对象的一些实用函数。

Kind：全局类

• 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

使用提供的 getter 和 setter 创建访问器属性描述符功能。

种类：ObjectUtilities
的静态方法 返回：PropertyDescriptor -

访问器属性描述符。

Param	Type	Description
[getter]	function	用作属性的 getter 的函数。
[setter]	function	用作属性设置器的函数。

---

ObjectUtilities.createDataPropertyDescriptor([value], [isWritable]) ⇒ PropertyDescriptor

使用提供的 value 和 isWritable 标志创建数据属性描述符。

种类：ObjectUtilities
的静态方法 返回：PropertyDescriptor -

数据属性描述符。

Param	Type	Description
[value]	\*	与属性关联的值。
[isWritable]	Boolean	一个布尔标志，用于确定是否可以使用赋值运算符更改属性的值。

---

ObjectUtilities.createDescribedFrozenObject([propertyDescriptors]) ⇒ Object

使用提供的 propertyDescriptors 创建冻结对象（通过 Object.freeze）来定义对象的属性。

种类：ObjectUtilities
的静态方法 返回：Object -

冻结的对象。

Param	Type	Description
[propertyDescriptors]	Array.<PropertyDescriptor>	定义对象的每个属性的一组属性描述符。

---

ObjectUtilities.createDescribedSealedObject([propertyDescriptors]) ⇒ Object

使用提供的 propertyDescriptors 创建密封对象（通过 Object.seal）来定义对象的属性。

种类：ObjectUtilities
的静态方法 返回：Object -

密封的对象。

Param	Type	Description
[propertyDescriptors]	Array.<PropertyDescriptor>	定义对象的每个属性的一组属性描述符。

---

ObjectUtilities.createEmptyObject() ⇒ Object

创建一个空原型空对象。

种类：ObjectUtilities
的静态方法 返回：Object -

对象。

---

ObjectUtilities.createEnumerableAccessorPropertyDescriptor([getter], [setter]) ⇒ PropertyDescriptor

使用提供的 getter 和 setter 函数创建可枚举访问器属性描述符。

种类：ObjectUtilities
的静态方法 返回：PropertyDescriptor -

可枚举访问器属性描述符。

Param	Type	Description
[getter]	function	用作属性的 getter 的函数。
[setter]	function	用作属性设置器的函数。

---

ObjectUtilities.createEnumerableDataPropertyDescriptor([value], [isWritable]) ⇒ PropertyDescriptor

使用提供的 value 和 isWritable 标志创建可枚举数据属性描述符。

种类：ObjectUtilities
的静态方法 返回：PropertyDescriptor -

可枚举数据属性描述符。

Param	Type	Description
[value]	\*	与属性关联的值。
[isWritable]	Boolean	一个布尔标志，用于确定是否可以使用赋值运算符更改属性的值。

---

ObjectUtilities.createFrozenObject([properties]) ⇒ Object

使用提供的 properties 创建冻结对象（通过 Object.freeze）。

种类：ObjectUtilities
的静态方法 返回：Object -

冻结的对象。

Param	Type	Description
[properties]	Object	对象的属性。

---

ObjectUtilities.createObject([properties]) ⇒ Object

使用提供的属性 创建一个对象。

种类：ObjectUtilities
的静态方法 返回：Object -

对象。

Param	Type	Description
[properties]	Object	对象的属性。

---

ObjectUtilities.createSealedObject([properties]) ⇒ Object

使用提供的 properties 创建密封对象（通过 Object.seal）。

种类：ObjectUtilities
的静态方法 返回：Object -

密封的对象。

Param	Type	Description
[properties]	Object	对象的属性。

---

Author

Jay B. j@1791.io>

License

Apache-2.0，Apache 许可，版本 2.0