Interface KeyValueStore<TState>

Key value store operations. Only keyed services have an attached key-value store.

interface KeyValueStore<TState extends TypedState> {
    clear<TKey extends string | number | symbol>(
        name: TState extends UntypedState ? string : TKey,
    ): void;
    clearAll(): void;
    get<TValue, TKey extends string | number | symbol = string>(
        name: TState extends UntypedState ? string : TKey,
        serde?: Serde<TState extends UntypedState ? TValue : TState[TKey]>,
    ): Promise<null | (TState extends UntypedState ? TValue : TState[TKey])>;
    set<TValue, TKey extends string | number | symbol = string>(
        name: TState extends UntypedState ? string : TKey,
        value: TState extends UntypedState ? TValue : TState[TKey],
        serde?: Serde<TState extends UntypedState ? TValue : TState[TKey]>,
    ): void;
    stateKeys(): Promise<string[]>;
}

Type Parameters

TState extends TypedState

Hierarchy (View Summary)

KeyValueStore
- ObjectContext

Index

Methods

clear clearAll get set stateKeys

Methods

clear

clear<TKey extends string | number | symbol>(
name: TState extends UntypedState ? string : TKey,
): void
Clear/delete state in the Restate runtime.
Type Parameters
- TKey extends string | number | symbol
Parameters
- name: TState extends UntypedState ? string : TKey
  key of the state to delete
Returns void
Example
```
ctx.clear("STATE");
```
- Defined in packages/restate-sdk/src/context.ts:131

clearAll

clearAll(): void
Clear/delete all the state entries in the Restate runtime.

Returns void
Example
```
ctx.clearAll();
```
- Defined in packages/restate-sdk/src/context.ts:141

get

get<TValue, TKey extends string | number | symbol = string>(
name: TState extends UntypedState ? string : TKey,
serde?: Serde<TState extends UntypedState ? TValue : TState[TKey]>,
): Promise<null | (TState extends UntypedState ? TValue : TState[TKey])>
Get/retrieve state from the Restate runtime. Note that state objects are serialized with Buffer.from(JSON.stringify(theObject)) and deserialized with JSON.parse(value.toString()) as T.
Type Parameters
- TValue
- TKey extends string | number | symbol = string
Parameters
- name: TState extends UntypedState ? string : TKey
  key of the state to retrieve
- Optionalserde: Serde<TState extends UntypedState ? TValue : TState[TKey]>
Returns Promise<null | (TState extends UntypedState ? TValue : TState[TKey])>
a Promise that is resolved with the value of the state key
Example
```
const state = await ctx.get<string>("STATE");
```
- Defined in packages/restate-sdk/src/context.ts:100

set

set<TValue, TKey extends string | number | symbol = string>(
    name: TState extends UntypedState ? string : TKey,
    value: TState extends UntypedState ? TValue : TState[TKey],
    serde?: Serde<TState extends UntypedState ? TValue : TState[TKey]>,
): void
Set/store state in the Restate runtime. Note that state objects are serialized with Buffer.from(JSON.stringify(theObject)) and deserialized with JSON.parse(value.toString()) as T.
Type Parameters
- TValue
- TKey extends string | number | symbol = string
Parameters
- name: TState extends UntypedState ? string : TKey
  key of the state to set
- value: TState extends UntypedState ? TValue : TState[TKey]
  value to set
- Optionalserde: Serde<TState extends UntypedState ? TValue : TState[TKey]>
Returns void
Example
```
ctx.set("STATE", "Hello");
```
- Defined in packages/restate-sdk/src/context.ts:118

stateKeys

stateKeys(): Promise<string[]>
Returns Promise<string[]>
- Defined in packages/restate-sdk/src/context.ts:105