Interface StateGetSuccess

Successful response from state.get.

interface StateGetSuccess {
    exists: boolean;
    expiresAt?: number;
    key?: string;
    success: true;
    value: JsonValue;
}

Properties

exists: boolean

Whether the key exists.

expiresAt?: number

When the value expires, in milliseconds since the Unix epoch; present for a value stored with ttlMs.

key?: string

The key; present when it exists.

success: true

Always true here; a failed call resolves with ApiFailure instead.

value: JsonValue

The value; null when the key does not exist.