@tavora/sdk / KeyValueStore
Interface: KeyValueStore
Defined in: packages/sdk/src/index.ts:202
Small key/value settings: at most 5 MB of keys and values together, values plain JSON.
Methods
compareAndSet()
compareAndSet(
key,expected,value):Promise<boolean>
Defined in: packages/sdk/src/index.ts:213
Sets value only while the key holds expected (null: the key is not set), in one step, so two panels can't overwrite each other's change. True when it was set; false when the key held something else, so read it again and retry. Values count as equal when they hold the same JSON, whatever the order of their keys. Tavora 0.21.92 and newer.
Parameters
key
string
expected
value
Returns
Promise<boolean>
delete()
delete(
key):Promise<void>
Defined in: packages/sdk/src/index.ts:206
Parameters
key
string
Returns
Promise<void>
get()
get<
T>(key):Promise<T|null>
Defined in: packages/sdk/src/index.ts:204
T is not checked at runtime; the host only guarantees the value is JSON.
Type Parameters
T
T = JsonValue
Parameters
key
string
Returns
Promise<T | null>
keys()
keys():
Promise<string[]>
Defined in: packages/sdk/src/index.ts:207
Returns
Promise<string[]>
set()
set(
key,value):Promise<void>
Defined in: packages/sdk/src/index.ts:205
Parameters
key
string
value
Returns
Promise<void>