ConversationStorage

^{ref / conversations / ConversationStorage}

A storage for versioned state.

Specify this to define how to persist data.

This type is a union of three types, each representing a different way to store data.

1. A VersionedStateStorage directly provides definitions for reading, writing, and deleting data based on ctx.chatId. No versions can be specified and the storage key function cannot be changed.
2. A ConversationKeyStorage, disambiguated via { type: "key" }, is more general. It supports versioning the data and changing the storage key function.
3. A ConversationContextStorage, disambiguated via { type: "context" }, is even more general. It no longer needs a storage key function. Instead, it provides read, write, and delete operations for data based on the context object directly. It also supports versioning data.

^Source

Type Parameters

C

C extends Context

S

S

Type

{ type?: never; version?: never } & VersionedStateStorage<string, S> | ConversationContextStorage<C, S> | ConversationKeyStorage<C, S>