Class MemoryPersistence

Default in-memory persistence implementation.

Stores user, chat, bot data, and conversation states in memory Maps. Data is reset when the process terminates.

Example

import { ApplicationBuilder, MemoryPersistence } from "telebot-ts";

const app = new ApplicationBuilder()
  .token("BOT_TOKEN")
  .persistence(new MemoryPersistence())
  .build();

Implements

Persistence

Index

Constructors

constructor

Methods

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

Constructors

constructor

new MemoryPersistence(): MemoryPersistence

Returns MemoryPersistence

Methods

deleteChatData

deleteChatData(chatId: string | number): Promise<void>
Deletes chat data for a specific chat ID from memory.
Parameters
- chatId: string | number
  Telegram chat ID.
Returns Promise<void>

Implementation of Persistence.deleteChatData

deleteConversation

deleteConversation(key: string): Promise<void>
Deletes conversation state for the given key from memory.
Parameters
- key: string
  Conversation composite key.
Returns Promise<void>

Implementation of Persistence.deleteConversation

deleteUserData

deleteUserData(userId: number): Promise<void>
Deletes user data for a specific user ID from memory.
Parameters
- userId: number
  Telegram user ID.
Returns Promise<void>

Implementation of Persistence.deleteUserData

getBotData

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

Retrieves bot data from memory.

Returns Promise<Record<string, unknown>>
Global bot data record.

Implementation of Persistence.getBotData

getChatData

getChatData(chatId: string | number): Promise<Record<string, unknown>>
Retrieves chat data from memory.
Parameters
- chatId: string | number
  Telegram chat ID.
Returns Promise<Record<string, unknown>>
The chat data record for chatId.

Implementation of Persistence.getChatData

getConversations

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

Retrieves a snapshot copy of all active conversation states.

Returns Promise<Map<string, string | number>>
A Map clone of conversation states.

Implementation of Persistence.getConversations

getJobs

getJobs(): Promise<PersistedJob[]>

Retrieves a copy of scheduled persisted jobs from memory.

Returns Promise<PersistedJob[]>
An array copy of persisted jobs.

Implementation of Persistence.getJobs

getUserData

getUserData(userId: number): Promise<Record<string, unknown>>
Retrieves user data from memory.
Parameters
- userId: number
  Telegram user ID.
Returns Promise<Record<string, unknown>>
The user data record for userId.

Implementation of Persistence.getUserData

setBotData

setBotData(data: Record<string, unknown>): Promise<void>
Stores bot data in memory.
Parameters
- data: Record<string, unknown>
  Global bot data record to store.
Returns Promise<void>
Resolves when saved in memory.

Implementation of Persistence.setBotData

setChatData

setChatData(
chatId: string | number,
data: Record<string, unknown>,
): Promise<void>
Stores chat data in memory.
Parameters
- chatId: string | number
  Telegram chat ID.
- data: Record<string, unknown>
  Chat data record to store.
Returns Promise<void>
Resolves when saved in memory.

Implementation of Persistence.setChatData

setJobs

setJobs(jobs: PersistedJob[]): Promise<void>
Overwrites the persisted jobs in memory.
Parameters
- jobs: PersistedJob[]
  Array of persisted jobs.
Returns Promise<void>
Resolves when updated.

Implementation of Persistence.setJobs

setUserData

setUserData(userId: number, data: Record<string, unknown>): Promise<void>
Stores user data in memory.
Parameters
- userId: number
  Telegram user ID.
- data: Record<string, unknown>
  User data record to store.
Returns Promise<void>
Resolves when saved in memory.

Implementation of Persistence.setUserData

updateConversation

updateConversation(key: string, state: string | number): Promise<void>
Updates conversation state for the given key in memory.
Parameters
- key: string
  Conversation composite key.
- state: string | number
  Current conversation state.
Returns Promise<void>
Resolves when updated in memory.

Implementation of Persistence.updateConversation

Class MemoryPersistence

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Returns MemoryPersistence

Methods

deleteChatData

Parameters

Returns Promise<void>

deleteConversation

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

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