このモジュールは、単一のグローバルストアを表します。
ストアには meeting.stores モジュールからアクセスできます。
戻り値: RTKStore のインスタンス。
例
const handRaiseStore = meeting.stores.stores.get('handRaise');- RTKStore ⇒
- .set(key, value, [sync], [emit]) ⇒
Promise.<void> - .bulkSet(data) ⇒
Promise.<void> - .update(key, value, [sync]) ⇒
Promise.<void> - .delete(key, [sync], [emit]) ⇒
Promise.<void> - .bulkDelete(data) ⇒
Promise.<void> - .get(key) ⇒
any - .getAll() ⇒
RTKStoreData - .clear()
- .updateRateLimits(num, period)
- .updateBulkRateLimits(num, period)
- .subscribe(key, cb) ⇒
void - .unsubscribe(key, [cb]) ⇒
void - .populate(data)
- .set(key, value, [sync], [emit]) ⇒
ストアに値を設定します。
種類: RTKStore のインスタンスメソッド
戻り値: Promise.<void> - Promise。
| パラメーター | 型 | デフォルト | 説明 |
|---|---|---|---|
| key | string |
値の保存に使う一意の識別子。 | |
| value | any |
設定するデータ。 | |
| [sync] | boolean |
true |
変更をリモートストアに同期するかどうか。 |
| [emit] | boolean |
false |
ローカルの購読者に emit するかどうか。 |
ストアに複数の値を設定します。
種類: RTKStore のインスタンスメソッド
戻り値: Promise.<void> - Promise。
| パラメーター | 型 |
|---|---|
| data | Array.<{key: string, payload: any}> |
ストア内の既存の値を更新します。
保存されている値が ['a', 'b'] のとき、
store.update(key, ['c']) を実行すると
値は ['a','b','c'] になります。
種類: RTKStore のインスタンスメソッド
戻り値: Promise.<void> - Promise。
| パラメーター | 型 | デフォルト | 説明 |
|---|---|---|---|
| key | string |
値の保存に使う一意の識別子。 | |
| value | any |
更新するデータ。 | |
| [sync] | boolean |
true |
変更をリモートストアに同期するかどうか。 |
ストアからキーと値のペアを削除します。
種類: RTKStore のインスタンスメソッド
戻り値: Promise.<void> - Promise。
| パラメーター | 型 | デフォルト | 説明 |
|---|---|---|---|
| key | string |
値の保存に使う一意の識別子。 | |
| [sync] | boolean |
true |
変更をリモートストアに同期するかどうか。 |
| [emit] | boolean |
false |
ローカルの購読者に emit するかどうか。 |
ストアから複数の値を削除します。
種類: RTKStore のインスタンスメソッド
戻り値: Promise.<void> - Promise。
| パラメーター | 型 |
|---|---|
| data | Array.<{key: string}> |
指定したキーの値を返します。
種類: RTKStore のインスタンスメソッド
戻り値: any - 指定したキーの値。
| パラメーター | 型 | 説明 |
|---|---|---|
| key | string |
値の保存に使う一意の識別子。 |
ストア全体を返します。
種類: RTKStore のインスタンスメソッド
戻り値: RTKStoreData - RTKStoreData のインスタンス。
ストア内のデータをすべて消去します。
種類: RTKStore のインスタンスメソッド
種類: RTKStore のインスタンスメソッド
| パラメーター | 型 |
|---|---|
| num | number |
| period | number |
種類: RTKStore のインスタンスメソッド
| パラメーター | 型 |
|---|---|
| num | number |
| period | number |
ストアのキーに対するデータ変更をリッスンします。
種類: RTKStore のインスタンスメソッド
戻り値: void - void
| パラメーター | 型 | 説明 |
|---|---|---|
| key | string |
値の保存に使う一意の識別子。 |
| cb | function |
データが変更されたときに実行されるコールバック関数。 |
ストア上のキーに対するリスナーをすべて削除します。
種類: RTKStore のインスタンスメソッド
戻り値: void - void
| パラメーター | 型 | 説明 |
|---|---|---|
| key | string |
値の保存に使う一意の識別子。 |
| [cb] | function |
削除するコールバック。 |
種類: RTKStore のインスタンスメソッド
| パラメーター | 型 |
|---|---|
| data | RTKStoreData |