Interface StateSetParams

Parameters for state.set. Store a value in the shared state and announce it with state:changed, unless silent.

interface StateSetParams {
    key: string;
    silent?: boolean;
    ttlMs?: number;
    value: JsonValue;
}

Properties

key: string

The key.

silent?: boolean

Store without announcing state:changed.

false

ttlMs?: number

Lifetime in milliseconds, after which the value is removed; 0 or less stores it without expiry.

value: JsonValue

The value to store. null counts as missing; remove a key with state.delete.