- RTKStore
- store.set(key, value, [sync], [emit]) ⇒ Promise.<void>
- store.bulkSet(data) ⇒ Promise.<void>
- store.update(key, value, [sync]) ⇒ Promise.<void>
- store.delete(key, [sync], [emit]) ⇒ Promise.<void>
- store.bulkDelete(data) ⇒ Promise.<void>
- store.get(key) ⇒ any
- store.getAll() ⇒ RTKStoreData
- store.clear()
- store.updateRateLimits(num, period)
- store.updateBulkRateLimits(num, period)
- store.subscribe(key, cb) ⇒ void
- store.unsubscribe(key, [cb]) ⇒ void
- store.populate(data)
- On this page
RTKStore
Last updated Oct 19, 2026
This module represents a single global store. The store can be accessed from the meeting.stores module.
Returns: An instance of RTKStore.
Example
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)
store.set(key, value, [sync], [emit]) ⇒ Promise.<void>
Sets a value in the store.
Kind: instance method of RTKStore
Returns: Promise.<void> - A promise.
| Param | Type | Default | Description |
|---|---|---|---|
| key | string |
Unique identifier used to store value. | |
| value | any |
Data to be set. | |
| [sync] | boolean |
true |
Whether to sync change to remote store. |
| [emit] | boolean |
false |
Whether to emit to local subscribers. |
store.bulkSet(data) ⇒ Promise.<void>
Sets multiple values in the store.
Kind: instance method of RTKStore
Returns: Promise.<void> - A promise.
| Param | Type |
|---|---|
| data | Array.<{key: string, payload: any}> |
store.update(key, value, [sync]) ⇒ Promise.<void>
Updates an already existing value in the store. If the value stored is ['a', 'b'], the operation store.update(key, ['c']) will modify the value to ['a','b','c'].
Kind: instance method of RTKStore
Returns: Promise.<void> - A promise.
| Param | Type | Default | Description |
|---|---|---|---|
| key | string |
Unique identifier used to store value. | |
| value | any |
Data to be updated. | |
| [sync] | boolean |
true |
Whether to sync change to remote store. |
store.delete(key, [sync], [emit]) ⇒ Promise.<void>
Deletes a key value pair form the store.
Kind: instance method of RTKStore
Returns: Promise.<void> - A promise.
| Param | Type | Default | Description |
|---|---|---|---|
| key | string |
Unique identifier used to store value. | |
| [sync] | boolean |
true |
Whether to sync change to remote store. |
| [emit] | boolean |
false |
Whether to emit to local subscribers. |
store.bulkDelete(data) ⇒ Promise.<void>
Deletes multiple values from the store.
Kind: instance method of RTKStore
Returns: Promise.<void> - A promise.
| Param | Type |
|---|---|
| data | Array.<{key: string}> |
store.get(key) ⇒ any
Returns value for the given key.
Kind: instance method of RTKStore
Returns: any - Value for the given key.
| Param | Type | Description |
|---|---|---|
| key | string |
Unique identifier used to store value. |
store.getAll() ⇒ RTKStoreData
Returns the entire store.
Kind: instance method of RTKStore
Returns: RTKStoreData - An instance of RTKStoreData.
store.clear()
Clears all data in the store.
Kind: instance method of RTKStore
store.updateRateLimits(num, period)
Kind: instance method of RTKStore
| Param | Type |
|---|---|
| num | number |
| period | number |
store.updateBulkRateLimits(num, period)
Kind: instance method of RTKStore
| Param | Type |
|---|---|
| num | number |
| period | number |
store.subscribe(key, cb) ⇒ void
Listens for data change on a store key.
Kind: instance method of RTKStore
Returns: void - void
| Param | Type | Description |
|---|---|---|
| key | string |
Unique identifier used to store value. |
| cb | function |
The callback function that gets executed when data is modified. |
store.unsubscribe(key, [cb]) ⇒ void
Removes all listeners for a key on the store.
Kind: instance method of RTKStore
Returns: void - void
| Param | Type | Description |
|---|---|---|
| key | string |
Unique identifier used to store value. |
| [cb] | function |
Callback to be removed. |
store.populate(data)
Kind: instance method of RTKStore
| Param | Type |
|---|---|
| data | RTKStoreData |
Was this helpful?
YesNo
On this page
{"@context":"https://schema.org","@type":"TechArticle","@id":"https://developers.cloudflare.com/realtime/realtimekit/humans/core/api-reference/rtkstore/#page","headline":"RTKStore","url":"https://developers.cloudflare.com/realtime/realtimekit/humans/core/api-reference/rtkstore/","inLanguage":"en","image":"https://developers.cloudflare.com/realtime/realtimekit/humans/core/api-reference/rtkstore/og.png?v=975552cd54f31734","dateModified":"2026-10-19","publisher":{"@type":"Organization","name":"Cloudflare","description":"One platform for your apps, agents, and workforce. Build, secure, and scale without managing infrastructure","url":"https://www.cloudflare.com/","sameAs":["https://github.com/cloudflare","https://www.linkedin.com/company/cloudflare","https://x.com/cloudflare"],"logo":{"@type":"ImageObject","url":"https://developers.cloudflare.com/logo.svg"},"address":{"@type":"PostalAddress","streetAddress":"101 Townsend St","addressLocality":"San Francisco","addressRegion":"CA","postalCode":"94107","addressCountry":"US"},"contactPoint":[{"@type":"ContactPoint","contactType":"Customer Support","url":"https://support.cloudflare.com/","availableLanguage":["English"]},{"@type":"ContactPoint","contactType":"Sales","url":"https://www.cloudflare.com/contact/","availableLanguage":["English"]}]},"isPartOf":{"@type":"WebSite","@id":"https://developers.cloudflare.com/#website","name":"Cloudflare Docs","url":"https://developers.cloudflare.com/"}}
title: RTKThemePreset image: https://developers.cloudflare.com/realtime/realtimekit/humans/core/api-reference/rtkthemepreset/og.png?v=a3626400e1ffdab6
Documentation Index
Fetch the complete documentation index at: https://developers.cloudflare.com/realtime/llms.txt
Use this file to discover all available pages before exploring further.
Docs