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

发布于 5年前 浏览 40 项目主页 更新于 3年前

Project: ObjectUtilities

JavaScript 对象的一些实用函数。

npm(最新版本) 大卫 David (dev) npm(许可证)

Travis CI(分支: master) Travis CI(分支:开发)

Coveralls (branch: master) Coveralls (branch: develop)

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

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

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

访问器属性描述符。

Param Type Description
[getter] function

用作属性的 getter 的函数。

[setter] function

用作属性设置器的函数。


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

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

种类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

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

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

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

Param Type Description
[getter] function

用作属性的 getter 的函数。

[setter] function

用作属性设置器的函数。


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

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

种类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.0Apache 许可,版本 2.0

Project: ObjectUtilities

Some utility functions for JavaScript objects.

npm (latest version) David David (dev) npm (license)

Travis CI (branch: master) Travis CI (branch: develop)

Coveralls (branch: master) Coveralls (branch: develop)

Installation

To install ObjectUtilities, run:

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

Usage

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

API

ObjectUtilities

Some utility functions for JavaScript objects.

Kind: global class


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

Creates an accessor property descriptor using the provided getter and setter functions.

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

Creates a data property descriptor using the provided value and isWritable flag.

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

Creates a frozen object (via Object.freeze) using the provided propertyDescriptors to define the properties of the 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

Creates a sealed object (via Object.seal) using the provided propertyDescriptors to define the properties of the 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

Creates a null-prototyped empty object.

Kind: static method of ObjectUtilities
Returns: Object -

The object.


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

Creates an enumerable accessor property descriptor using the provided getter and setter functions.

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

Creates an enumerable data property descriptor using the provided value and isWritable flag.

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

Creates a frozen object (via Object.freeze) with the provided properties.

Kind: static method of ObjectUtilities
Returns: Object -

The frozen object.

Param Type Description
[properties] Object

The properties of the object.


ObjectUtilities.createObject([properties]) ⇒ Object

Creates an object with the provided properties.

Kind: static method of ObjectUtilities
Returns: Object -

The object.

Param Type Description
[properties] Object

The properties of the object.


ObjectUtilities.createSealedObject([properties]) ⇒ Object

Creates a sealed object (via Object.seal) with the provided properties.

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>

License

Apache-2.0, Apache License, Version 2.0

更多

友情链接

    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文