Skip to content

非公式本サイトは非公式の日本語ドキュメントであり、Cloudflare 公式サイトではありません。最新情報はdevelopers.cloudflare.comをご確認ください。

RTKStore

最終更新 Markdown で表示Agent セットアップ

このモジュールは、単一のグローバルストアを表します。 ストアには meeting.stores モジュールからアクセスできます。

戻り値: RTKStore のインスタンス。

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

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

ストアに値を設定します。

種類: RTKStore のインスタンスメソッド
戻り値: Promise.<void> - Promise。

パラメーター デフォルト 説明
key string 値の保存に使う一意の識別子。
value any 設定するデータ。
[sync] boolean true 変更をリモートストアに同期するかどうか。
[emit] boolean false ローカルの購読者に emit するかどうか。

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

ストアに複数の値を設定します。

種類: RTKStore のインスタンスメソッド
戻り値: Promise.<void> - Promise。

パラメーター
data Array.<{key: string, payload: any}>

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

ストア内の既存の値を更新します。 保存されている値が ['a', 'b'] のとき、 store.update(key, ['c']) を実行すると 値は ['a','b','c'] になります。

種類: RTKStore のインスタンスメソッド
戻り値: Promise.<void> - Promise。

パラメーター デフォルト 説明
key string 値の保存に使う一意の識別子。
value any 更新するデータ。
[sync] boolean true 変更をリモートストアに同期するかどうか。

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

ストアからキーと値のペアを削除します。

種類: RTKStore のインスタンスメソッド
戻り値: Promise.<void> - Promise。

パラメーター デフォルト 説明
key string 値の保存に使う一意の識別子。
[sync] boolean true 変更をリモートストアに同期するかどうか。
[emit] boolean false ローカルの購読者に emit するかどうか。

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

ストアから複数の値を削除します。

種類: RTKStore のインスタンスメソッド
戻り値: Promise.<void> - Promise。

パラメーター
data Array.<{key: string}>

store.get(key) ⇒ any

指定したキーの値を返します。

種類: RTKStore のインスタンスメソッド
戻り値: any - 指定したキーの値。

パラメーター 説明
key string 値の保存に使う一意の識別子。

store.getAll() ⇒ RTKStoreData

ストア全体を返します。

種類: RTKStore のインスタンスメソッド
戻り値: RTKStoreData - RTKStoreData のインスタンス。

store.clear()

ストア内のデータをすべて消去します。

種類: RTKStore のインスタンスメソッド

store.updateRateLimits(num, period)

種類: RTKStore のインスタンスメソッド

パラメーター
num number
period number

store.updateBulkRateLimits(num, period)

種類: RTKStore のインスタンスメソッド

パラメーター
num number
period number

store.subscribe(key, cb) ⇒ void

ストアのキーに対するデータ変更をリッスンします。

種類: RTKStore のインスタンスメソッド
戻り値: void - void

パラメーター 説明
key string 値の保存に使う一意の識別子。
cb function データが変更されたときに実行されるコールバック関数。

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

ストア上のキーに対するリスナーをすべて削除します。

種類: RTKStore のインスタンスメソッド
戻り値: void - void

パラメーター 説明
key string 値の保存に使う一意の識別子。
[cb] function 削除するコールバック。

store.populate(data)

種類: RTKStore のインスタンスメソッド

パラメーター
data RTKStoreData

役に立ちましたか?