Interface StateScope

A key-value store for a single state scope (conversation, user, or temp).

interface StateScope {
    get<T = unknown>(key: string): T | undefined;
    set<T>(key: string, value: T): void;
    has(key: string): boolean;
    delete(key: string): void;
    clear(): void;
}

Implemented by

StateScopeImpl

Index

Methods

get set has delete clear

Methods

get

get<T = unknown>(key: string): T | undefined
Get a value by key.
Type Parameters
- T = unknown
Parameters
- key: string
  The property key.
Returns T | undefined
The value, or undefined if not present.
- Defined in packages/botas-core/src/state/state-scope.ts:13

set

set<T>(key: string, value: T): void
Set a value by key.
Type Parameters
- T
Parameters
- key: string
  The property key.
- value: T
  The value to store.
Returns void
- Defined in packages/botas-core/src/state/state-scope.ts:20

has

has(key: string): boolean
Check if a key exists.
Parameters
- key: string
  The property key.
Returns boolean
True if the key exists.
- Defined in packages/botas-core/src/state/state-scope.ts:27

delete

delete(key: string): void
Delete a value by key.
Parameters
- key: string
  The property key.
Returns void
- Defined in packages/botas-core/src/state/state-scope.ts:33

clear

clear(): void
Clear all values in this scope.

Returns void
- Defined in packages/botas-core/src/state/state-scope.ts:38