Class: ConversationState
Defined in: state/ConversationState.ts:7
A per-chat view over the StateStore. Lets you read and write small pieces of conversation state (a step, a cart, whatever) scoped to one chat.
Constructors
Constructor
new ConversationState(
store,chatId):ConversationState
Defined in: state/ConversationState.ts:8
Parameters
store
chatId
string
Returns
ConversationState
Methods
all()
all():
Promise<Record<string,unknown>>
Defined in: state/ConversationState.ts:14
The full state object for this chat.
Returns
Promise<Record<string, unknown>>
clear()
clear():
Promise<void>
Defined in: state/ConversationState.ts:44
Clears all state for this chat.
Returns
Promise<void>
delete()
delete(
key):Promise<void>
Defined in: state/ConversationState.ts:37
Removes a single value.
Parameters
key
string
Returns
Promise<void>
get()
get<
T>(key):Promise<T|undefined>
Defined in: state/ConversationState.ts:19
Reads a single value.
Type Parameters
T
T = unknown
Parameters
key
string
Returns
Promise<T | undefined>
patch()
patch(
values):Promise<void>
Defined in: state/ConversationState.ts:31
Merges several values at once.
Parameters
values
Record<string, unknown>
Returns
Promise<void>
set()
set(
key,value):Promise<void>
Defined in: state/ConversationState.ts:24
Writes a single value.
Parameters
key
string
value
unknown
Returns
Promise<void>