@action-land/core 中文文档教程

Question

@action-type/core

动作的核心库。

Index

• Installation
• Specification
• Action
• API
• action
• isAction
• Nil
• List
• isList
• Related Libraries

Installation

npm i @action-land/core

Specification

1. An Action consists of two properties viz. type and value.
2. action.type is of type string or number.
3. action.value is of type any. It could also be of type Action
4. The object is an immutable and should never be updated.

Action Type

一个动作是一个包含两个属性的对象——type 和 value。

interface Action<T> {
  type: string
  value: T
}

API

action

有助于创建新的操作类型对象的实用程序。 该函数默认是柯里化的，并提供类型保证。

import {action} from '@action-land/core'

action('click', {x: 10, y: 20})

action('click')({x: 10, y: 20}) // curried version

isAction

检测对象是否为 Action 类型的实用程序函数。

import {isAction} from '@action-land/core'

isAction({}) // returns false
isAction(action('WWW', null)) // returns true

Nil

代表虚无的默认动作。

import {Nil} from '@action-land/core'

function logic(a: number) {
  if (a > 10) return action('greater', a - 10)
  if (a < 10) return action('lesser', 10 - a)
  return Nil
}

List

从 Action[] 列表创建 Action 的实用程序函数。

import {List} from '@action-land/core'

const list = List(action('A', 1), action('B', 2))

isList

检查操作是否为列表类型

import {isList} from '@action-land/core'

const list = List(action('A', 1), action('B', 2))

isList(list) //true

isNil

的实用函数 检查操作是否为 Nil 的实用函数

import {isNil, Nil} from '@action-land/core'

isNil(Nil) // true
isNil({type: '@@NIL', value: {}}) // true
isNil({type: 'click', value: {}}) // false