Class BasePersistence`Abstract`

Base abstract persistence class that handles common serialization and key-value mapping.

Extending this class allows writing new database drivers (PostgreSQL, Redis, MongoDB) with minimal boilerplate code.

Example

export class SimpleKvPersistence extends BasePersistence {
  private store = new Map<string, string>();
  protected async getRaw(key: string) { return this.store.get(key) ?? null; }
  protected async setRaw(key: string, val: string) { this.store.set(key, val); }
  protected async deleteRaw(key: string) { this.store.delete(key); }
}

Implements

Persistence

Index

Constructors

constructor

Methods

deleteChatData deleteConversation deleteRaw deleteUserData getBotData getChatData getConversations getJobs getRaw getUserData setBotData setChatData setJobs setRaw setUserData updateConversation

Constructors

constructor

new BasePersistence(): BasePersistence

Returns BasePersistence

Methods

deleteChatData

deleteChatData(chatId: string | number): Promise<void>
Optional method to delete chat data for a specific chat ID.
Parameters
- chatId: string | number
  Telegram chat ID.
Returns Promise<void>

Implementation of Persistence.deleteChatData

deleteConversation

deleteConversation(key: string): Promise<void>
Optional method to delete conversation state.
Parameters
- key: string
  Conversation key composite.
Returns Promise<void>

Implementation of Persistence.deleteConversation

`Protected` `Abstract`deleteRaw

deleteRaw(key: string): Promise<void>
Parameters
- key: string
Returns Promise<void>

deleteUserData

deleteUserData(userId: number): Promise<void>
Optional method to delete user data for a specific user ID.
Parameters
- userId: number
  Telegram user ID.
Returns Promise<void>

Implementation of Persistence.deleteUserData

getBotData

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

Retrieves global bot data.

Returns Promise<Record<string, unknown>>
Bot data object.

Implementation of Persistence.getBotData

getChatData

getChatData(chatId: string | number): Promise<Record<string, unknown>>
Retrieves stored chat data for a specific chat ID.
Parameters
- chatId: string | number
  Telegram chat ID (number or string).
Returns Promise<Record<string, unknown>>
Chat data object (returns empty object if none found).

Implementation of Persistence.getChatData

getConversations

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

Retrieves all active conversation states.

Returns Promise<Map<string, string | number>>
A map of conversation keys to state values.

Implementation of Persistence.getConversations

getJobs

getJobs(): Promise<PersistedJob[]>

Retrieves all persisted scheduled jobs.

Returns Promise<PersistedJob[]>
Array of PersistedJob definitions.

Implementation of Persistence.getJobs

`Protected` `Abstract`getRaw

getRaw(key: string): Promise<string | null>
Parameters
- key: string
Returns Promise<string | null>

getUserData

getUserData(userId: number): Promise<Record<string, unknown>>
Retrieves stored user data for a specific user ID.
Parameters
- userId: number
  Telegram user ID.
Returns Promise<Record<string, unknown>>
User data object (returns empty object if none found).

Implementation of Persistence.getUserData

setBotData

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

Implementation of Persistence.setBotData

setChatData

setChatData(
chatId: string | number,
data: Record<string, unknown>,
): Promise<void>
Stores chat data for a specific chat ID.
Parameters
- chatId: string | number
  Telegram chat ID (number or string).
- data: Record<string, unknown>
  Key-value map of chat state.
Returns Promise<void>
Resolves when data is saved.

Implementation of Persistence.setChatData

setJobs

setJobs(jobs: PersistedJob[]): Promise<void>
Overwrites the list of persisted scheduled jobs.
Parameters
- jobs: PersistedJob[]
  Array of PersistedJob definitions.
Returns Promise<void>
Resolves when jobs are saved.

Implementation of Persistence.setJobs

`Protected` `Abstract`setRaw

setRaw(key: string, value: string): Promise<void>
Parameters
- key: string
- value: string
Returns Promise<void>

setUserData

setUserData(userId: number, data: Record<string, unknown>): Promise<void>
Stores user data for a specific user ID.
Parameters
- userId: number
  Telegram user ID.
- data: Record<string, unknown>
  Key-value map of user state.
Returns Promise<void>
Resolves when data is saved.

Implementation of Persistence.setUserData

updateConversation

updateConversation(key: string, state: string | number): Promise<void>
Updates or saves the state for a specific conversation key.
Parameters
- key: string
  Conversation key composite (e.g. chat_id + user_id).
- state: string | number
  Conversation state identifier or step number.
Returns Promise<void>
Resolves when state is updated.

Implementation of Persistence.updateConversation

Class BasePersistenceAbstract

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Returns BasePersistence

Methods

deleteChatData

Parameters

Returns Promise<void>

deleteConversation

Parameters

Returns Promise<void>

Protected AbstractdeleteRaw

Parameters

Returns Promise<void>

deleteUserData

Parameters

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[]>

Protected AbstractgetRaw

Parameters

Returns Promise<string | null>

getUserData

Parameters

Returns Promise<Record<string, unknown>>

setBotData

Parameters

Returns Promise<void>

setChatData

Parameters

Returns Promise<void>

setJobs

Parameters

Returns Promise<void>

Protected AbstractsetRaw

Parameters

Returns Promise<void>

setUserData

Parameters

Returns Promise<void>

updateConversation

Parameters

Returns Promise<void>

Settings

On This Page

Class BasePersistence`Abstract`

`Protected` `Abstract`deleteRaw

`Protected` `Abstract`getRaw

`Protected` `Abstract`setRaw