Class JsonFilePersistence

Persists user data, chat data, bot data, conversation states, and jobs to a single JSON file.

Example

const persistence = new JsonFilePersistence({ filePath: "./data/state.json" });

Implements

Persistence

Index

Constructors

constructor

Methods

deleteChatData deleteConversation deleteUserData flush getBotData getChatData getConversations getJobs getUserData setBotData setChatData setJobs setUserData updateConversation

Constructors

constructor

new JsonFilePersistence(
options: JsonFilePersistenceOptions,
): JsonFilePersistence
Creates a new instance of JsonFilePersistence.
Parameters
- options: JsonFilePersistenceOptions
  Configuration options specifying file path.
Returns JsonFilePersistence

Methods

deleteChatData

deleteChatData(chatId: string | number): Promise<void>
Deletes chat data for the given chat ID.
Parameters
- chatId: string | number
  Telegram chat ID.
Returns Promise<void>

Implementation of Persistence.deleteChatData

deleteConversation

deleteConversation(key: string): Promise<void>
Deletes state for a conversation key.
Parameters
- key: string
  Conversation identifier.
Returns Promise<void>

Implementation of Persistence.deleteConversation

deleteUserData

deleteUserData(userId: number): Promise<void>
Deletes user data for the given user ID.
Parameters
- userId: number
  Telegram user ID.
Returns Promise<void>

Implementation of Persistence.deleteUserData

flush

flush(): Promise<void>

Flushes any pending disk updates.

Returns Promise<void>

Implementation of Persistence.flush

getBotData

getBotData(): Promise<Record<string, unknown>>

Retrieves global bot data.

Returns Promise<Record<string, unknown>>
Key-value map of bot data.

Implementation of Persistence.getBotData

getChatData

getChatData(chatId: string | number): Promise<Record<string, unknown>>
Retrieves chat data for the given chat ID.
Parameters
- chatId: string | number
  Telegram chat ID.
Returns Promise<Record<string, unknown>>
Key-value map of chat data.

Implementation of Persistence.getChatData

getConversations

getConversations(): Promise<Map<string, string | number>>

Retrieves all active conversation states.

Returns Promise<Map<string, string | number>>
Map of conversation keys to states.

Implementation of Persistence.getConversations

getJobs

getJobs(): Promise<PersistedJob[]>

Retrieves persisted jobs.

Returns Promise<PersistedJob[]>
List of persisted jobs.

Implementation of Persistence.getJobs

getUserData

getUserData(userId: number): Promise<Record<string, unknown>>
Retrieves user data for the given user ID.
Parameters
- userId: number
  Telegram user ID.
Returns Promise<Record<string, unknown>>
Key-value map of user data.

Implementation of Persistence.getUserData

setBotData

setBotData(data: Record<string, unknown>): Promise<void>
Stores global bot data.
Parameters
- data: Record<string, unknown>
  Key-value map to store.
Returns Promise<void>
Resolves when saved.

Implementation of Persistence.setBotData

setChatData

setChatData(
chatId: string | number,
data: Record<string, unknown>,
): Promise<void>
Stores chat data for the given chat ID.
Parameters
- chatId: string | number
  Telegram chat ID.
- data: Record<string, unknown>
  Key-value map to store.
Returns Promise<void>
Resolves when saved.

Implementation of Persistence.setChatData

setJobs

setJobs(jobs: PersistedJob[]): Promise<void>
Overwrites persisted jobs.
Parameters
- jobs: PersistedJob[]
  List of persisted jobs.
Returns Promise<void>
Resolves when saved.

Implementation of Persistence.setJobs

setUserData

setUserData(userId: number, data: Record<string, unknown>): Promise<void>
Stores user data for the given user ID.
Parameters
- userId: number
  Telegram user ID.
- data: Record<string, unknown>
  Key-value map to store.
Returns Promise<void>
Resolves when saved.

Implementation of Persistence.setUserData

updateConversation

updateConversation(key: string, state: string | number): Promise<void>
Updates state for a conversation key.
Parameters
- key: string
  Conversation identifier.
- state: string | number
  Current step/state.
Returns Promise<void>
Resolves when saved.

Implementation of Persistence.updateConversation

Class JsonFilePersistence

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns JsonFilePersistence

Methods

deleteChatData

Parameters

Returns Promise<void>

deleteConversation

Parameters

Returns Promise<void>

deleteUserData

Parameters

Returns Promise<void>

flush

Returns Promise<void>

getBotData

Returns Promise<Record<string, unknown>>

getChatData

Parameters

Returns Promise<Record<string, unknown>>

getConversations

Returns Promise<Map<string, string | number>>

getJobs

Returns Promise<PersistedJob[]>

getUserData

Parameters

Returns Promise<Record<string, unknown>>

setBotData

Parameters

Returns Promise<void>

setChatData

Parameters

Returns Promise<void>

setJobs

Parameters

Returns Promise<void>

setUserData

Parameters

Returns Promise<void>

updateConversation

Parameters

Returns Promise<void>

Settings

On This Page