Interface SharedState<TState>

Read-only state, for handlers running under an ObjectSharedContext or WorkflowSharedContext.

interface SharedState<TState extends TypedState = UntypedState> {
    get<TValue, TKey extends string | number | symbol = string>(
        name: TState extends UntypedState ? string : TKey,
        serde?: Serde<TState extends UntypedState ? TValue : TState[TKey]>,
    ): Future<(TState extends UntypedState ? TValue : TState[TKey]) | null>;
    keys(): Future<string[]>;
}

Type Parameters

TState extends TypedState = UntypedState

Hierarchy (View Summary)

SharedState
- State

Index

Methods

Methods

get

get<TValue, TKey extends string | number | symbol = string>(
name: TState extends UntypedState ? string : TKey,
serde?: Serde<TState extends UntypedState ? TValue : TState[TKey]>,
): Future<(TState extends UntypedState ? TValue : TState[TKey]) | null>
Read a state value. Returns null if the key isn't set.
Type Parameters
- TValue
- TKey extends string | number | symbol = string
Parameters
- name: TState extends UntypedState ? string : TKey
- Optionalserde: Serde<TState extends UntypedState ? TValue : TState[TKey]>
Returns Future<(TState extends UntypedState ? TValue : TState[TKey]) | null>
- Defined in packages/libs/restate-sdk-gen/src/state.ts:55

keys

keys(): Future<string[]>
List all currently-known state keys.

Returns Future<string[]>
- Defined in packages/libs/restate-sdk-gen/src/state.ts:61