rukawa
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

rukawa

NPM version NPM downloads

安装

$ npm install rukawa

简单使用

import { useRukawa } from 'rukawa';

const {
  rukawaValues,
  setRukawaValue
} = useRukawa({
  name: 'test',
  subscribes: [
    'test-1'
  ],
  initialValue: ''
}, {
  debounce: 500
})

提供一个 useRukawahook,可以从中导出 rukawaValuessetRukawaValue, rukawaValues 是订阅的节点的 values 集合, setRukawaValue 是更改当前节点的值, 更改后,订阅该值的节点中的 rukawaValues, 会获取到最新的值。

API 介绍

userukawa 可以接受 2 个参数, propsoptions

props

参数 说明 类型 必填
name 节点名称 string
subscribes 订阅节点名称 string[]
initialValue 节点初始值 any
broadcastOnMounted 初次挂载是否广播value boolean
ignoreSameValue 是否忽略相同的值 boolean
valueState 是否需要返回当前节点 value boolean

options

参数 说明 类型 默认值
debounce 防抖 number -
formatResult rukawaValue 进行预处理 (values) => any -
pipes rx pipes OperatorFunction<any, any>[] -

return

参数 说明 类型
rukawaValues 订阅节点值 any
valuesDetail 当前值和上一次更改的值 { currentValues, oldValues }
setRukawaValue 更改当前节点值 (value) => void
value 当前节点值(需要开启 valueState any

其他

开启调试,可以看到每次值的传递。

import { getRukawa } from 'rukawa';

getRukawa().showValue();

LICENSE

MIT

Readme

Keywords

Package Sidebar

Install

npm i rukawa

Weekly Downloads

0

Version

1.0.0

License

MIT

Unpacked Size

23 kB

Total Files

10

Last publish

Collaborators

  • lvyouyou