跳转到内容
搜索文档

RTKStore

最后更新 查看 MarkdownAgent 设置

该模块表示单个全局 store。 可以从 meeting.stores 模块访问该 store。

返回:RTKStore 的实例。
示例

const handRaiseStore = meeting.stores.stores.get('handRaise');

store.set(key, value, [sync], [emit]) ⇒ Promise.<void>

在 store 中设置值。

类型: RTKStore 的实例方法
返回: Promise.<void> - 一个 promise。

参数 类型 默认值 描述
key string 用于存储值的唯一标识符。
value any 要设置的数据。
[sync] boolean true 是否将更改同步到远程 store。
[emit] boolean false 是否向本地订阅者广播。

store.bulkSet(data) ⇒ Promise.<void>

在 store 中设置多个值。

类型: RTKStore 的实例方法
返回: Promise.<void> - 一个 promise。

参数 类型
data Array.<{key: string, payload: any}>

store.update(key, value, [sync]) ⇒ Promise.<void>

更新 store 中已经存在的值。 如果存储的值是 ['a', 'b'],则操作 store.update(key, ['c']) 会将值修改为 ['a','b','c']

类型: RTKStore 的实例方法
返回: Promise.<void> - 一个 promise。

参数 类型 默认值 描述
key string 用于存储值的唯一标识符。
value any 要更新的数据。
[sync] boolean true 是否将更改同步到远程 store。

store.delete(key, [sync], [emit]) ⇒ Promise.<void>

从 store 中删除键值对。

类型: RTKStore 的实例方法
返回: Promise.<void> - 一个 promise。

参数 类型 默认值 描述
key string 用于存储值的唯一标识符。
[sync] boolean true 是否将更改同步到远程 store。
[emit] boolean false 是否向本地订阅者广播。

store.bulkDelete(data) ⇒ Promise.<void>

从 store 中删除多个值。

类型: RTKStore 的实例方法
返回: Promise.<void> - 一个 promise。

参数 类型
data Array.<{key: string}>

store.get(key) ⇒ any

返回给定键的值。

类型: RTKStore 的实例方法
返回: any - 给定键的值。

参数 类型 描述
key string 用于存储值的唯一标识符。

store.getAll() ⇒ RTKStoreData

返回整个 store。

类型: RTKStore 的实例方法
返回: RTKStoreData - RTKStoreData 的实例。

store.clear()

清除 store 中的所有数据。

类型: RTKStore 的实例方法

store.updateRateLimits(num, period)

类型: RTKStore 的实例方法

参数 类型
num number
period number

store.updateBulkRateLimits(num, period)

类型: RTKStore 的实例方法

参数 类型
num number
period number

store.subscribe(key, cb) ⇒ void

监听 store 键的数据更改。

类型: RTKStore 的实例方法
返回: void - void

参数 类型 描述
key string 用于存储值的唯一标识符。
cb function 数据被修改时执行的回调函数。

store.unsubscribe(key, [cb]) ⇒ void

移除 store 上某键的所有监听器。

类型: RTKStore 的实例方法
返回: void - void

参数 类型 描述
key string 用于存储值的唯一标识符。
[cb] function 要移除的回调函数。

store.populate(data)

类型: RTKStore 的实例方法

参数 类型
data RTKStoreData

这篇文档对您有帮助吗?