@activimetrics/utils-composite 中文文档教程

Question

@activimetrics/utils-composite

复合实用程序（不可变性、fp 助手）

注意：API 中描述的所有函数都是科里化的

注意：从 jumpn 派生/utils-composite 以升级依赖

• Installation
• Using npm
• Using yarn
• Types
• API
• get
  • Parameters
• getIn
  • Parameters
• getKeys
  • Parameters
• hasIn
  • Parameters
• hasKey
  • Parameters
• haveSameProps
  • Parameters
• is
  • Parameters
• isEmpty
  • Parameters
• map
  • Parameters
• arrayRemove
  • Parameters
• remove
  • Parameters
• removeIn
  • Parameters
• set
  • Parameters
• setIn
  • Parameters
• shallowCopy
  • Parameters
• shallowEqual
  • Parameters
• toUndefinedIfEmpty
  • Parameters
• updateIn
  • Parameters
• License

Installation

Using npm

$ npm install --save @activimetrics/utils-composite

Using yarn

$ yarn add @activimetrics/utils-composite

Types

type Composite = Array<*> | Object;

type Key = number | string;

type Path = Array<Key>;

API

get

项获取给定键的属性值。

Parameters

• key Key
• composite Composite

返回 any

getIn

返回位于给定路径或未定义的值。

Parameters

• path Path
• composite Composite

返回 any

getKeys

获取自己的可枚举键。

Parameters

• composite Composite

返回 Array

hasIn

如果找到值则返回真at given path 深深地等于那个 指定的。

Parameters

• path Path
• value any
• composite Composite

返回 boolean

hasKey

如果键包含在组合自身中，则返回 true可数的， 否则为假。

Parameters

• key Key
• composite Composite

返回 boolean

haveSameProps

如果两个组合具有相同的属性则返回 true否则为假。

Parameters

• c1 Composite
• c2 Composite

返回 boolean

is

如果参数是 Composite 或 false，则返回 true otherwise

Parameters

• thing any

isEmpty

如果 composite 没有自己的可枚举键（为空）或 false，则返回 true 否则

Parameters

• composite Composite

返回 boolean

map

使用映射器映射给定组合的值

Parameters

• mapper function (value: any, key: Key, composite: $Supertype<C>): any
• composite C

返回 $Supertype

arrayRemove

返回一个新数组，其中包含已删除指定数量的结果 给定索引处的（计数）元素。

Parameters

• index number
• count number
• array Array<Element>

返回 Array<Element>

remove

返回一个新的组合，其结果是删除了属性 给定的键。

Parameters

• key Key
• composite Composite

返回 Composite

removeIn

返回一个新的组合，其结果是删除了属性 位于给定路径。

（这与使用更新程序调用 updateIn 的效果相同： <代码>() => updateIn.remove)

Parameters

• path Path
• composite Composite

返回 Composite

set

返回一个新的组合，其结果是更新了属性 具有指定值的给定键。

Parameters

• key Key
• value any
• composite Composite

返回 Composite

setIn

返回具有更新属性结果的新组合 位于具有指定值的给定路径。

（这与使用更新器调用 updateIn 的效果相同：() => value

Parameters

• path Path
• value any
• composite Composite

>

shallowCopy

）给定的道具。

Parameters

• composite C

返回 C

shallowEqual

如果两个组合的类型相同（数组或对象）并且 它们的属性严格相等。

Parameters

• c1 Composite
• c2 Composite

返回 boolean

toUndefinedIfEmpty

返回给定的组合，如果它有任何自己的可枚举键（不为空）或 undefined otherwise

Parameters

• composite Composite

Returns Composite

updateIn

返回一个新的组合，其结果是更新了属性值 在给定路径上调用更新程序函数的结果。

通过在更新程序上返回 updateIn.remove 符号来支持条目删除 功能。

Parameters

• path Path
• updater function (prev: any): any
• composite Composite

返回 Composite

License

MIT :copyright: 2020 James Marca / (), 2017 Jumpn Limited