Class AppContext<TDbInfo, TQuery>

Внутренний класс для хранения состояния и конфигурации приложения. Используется внутри Bot для хранения состояния и конфигурации

Remarks

Разработчикам обычно НЕ нужно создавать экземпляры этого класса напрямую. Вместо этого используйте методы класса Bot:

bot.getAppContext() - получить доступ к контексту
bot.setAppConfig() - настроить конфигурацию
bot.setPlatformParams() - настроить параметры платформ

Этот класс содержит:

Конфигурацию приложения (IAppConfig)
Параметры платформ (IAppParam)
Регистрацию команд и интентов
Логирование и метрики
Подключение к БД

Example

// AppContext создаётся самим Bot:
const bot = new Bot();
const appContext = bot.getAppContext(); // если нужен прямой доступ

Type Parameters

TDbInfo = IDatabaseInfo
TQuery = unknown

Index

Constructors

constructor

new AppContext<TDbInfo = IDatabaseInfo, TQuery = unknown>(): AppContext<
TDbInfo,
TQuery,
>
Type Parameters
- TDbInfo = IDatabaseInfo
- TQuery = unknown
Returns AppContext<TDbInfo, TQuery>

Properties

appConfig

appConfig: Required<Omit<IAppConfig, "memorySession">> & Pick<
IAppConfig,
"memorySession",
> = ...

Конфигурация приложения

appMode

appMode: TAppMode = 'dev'

Определяет режим работы приложения

command

command: CommandReg = ...

Менеджер регистрации команд, шагов и событий (CommandReg). Сами команды — через геттер command.commands, шаги — command.steps.

database

database: {
    adapter?: IDatabaseAdapter;
    databaseInfo?: TDbInfo;
    isSendConnect?: boolean;
} = {}

Информация по подключению к базе данных.

Type Declaration

Optionaladapter?: IDatabaseAdapter
Адаптер для работы с базой данных
OptionaldatabaseInfo?: TDbInfo
Данные, необходимые адаптеру для работы
OptionalisSendConnect?: boolean
Флаг, определяющий, успешно ли подключился метод connect адаптера базы данных

httpClient

httpClient: THttpClient = global.fetch

Кастомный HTTP-клиент для выполнения всех исходящих запросов фреймворка. По умолчанию используется глобальный fetch. Вы можете заменить его на любой совместимый клиент (например, axios, undici, got), реализующий интерфейс:

(input: RequestInfo, init?: RequestInit) => Promise<Response>

Это позволяет:

добавлять retry-логику, таймауты, circuit breaker;
внедрять tracing, метрики или логирование всех запросов;
мокать сетевые вызовы в тестах;
использовать альтернативные HTTP-библиотеки.

Example

const bot = new Bot();
const ctx = bot.getAppContext();
ctx.httpClient = async (url, options) => {
  // добавляем таймаут 5 сек
  const controller = new AbortController();
  const id = setTimeout(() => controller.abort(), 5000);
  try {
    const res = await fetch(url, { ...options, signal: controller.signal });
    clearTimeout(id);
    return res;
  } catch (e) {
    clearTimeout(id);
    throw e;
  }
};

platformParams

platformParams: IAppParam = ...

Параметры приложения

platforms

platforms: IPlatform<TQuery> = {}

Список подключенных платформ

plugins

plugins: TAppPlugin = {}

Список подключенных плагинов

Accessors

commands

get commands(): Map<
string,
ICommandParam<BotController<IUserData, IPlatformData>>,
>
Получение всех зарегистрированных команд

Returns Map<string, ICommandParam<BotController<IUserData, IPlatformData>>>
- Defined in core/AppContext.ts:251

regexpGroup

get regexpGroup(): Map<string, IGroupData>
Получение всех зарегистрированных команд, которые распределены по группам. В группу добавляются только команды с регулярными выражениями. Группы используются для оптимизации поиска нужной команды

Returns Map<string, IGroupData>
- Defined in core/AppContext.ts:267

steps

get steps(): Map<string, IStepParam<BotController<IUserData, IPlatformData>>>
Получение всех зарегистрированных шагов

Returns Map<string, IStepParam<BotController<IUserData, IPlatformData>>>
- Defined in core/AppContext.ts:258

usedMetric

get usedMetric(): boolean
Возвращает флаг, который говорит о том, нужно ли собирать метрики

Returns boolean
true, если заданный логгер реализует метод metric
Example
```
if (ctx.usedMetric) {
  ctx.logMetric('GET_COMMAND', 0.42, { platform: 'alisa' });
}
```
- Defined in core/AppContext.ts:749

Methods

close

close(): Promise<void>
Закрывает все подключения, для корректного завершения работы приложения

Returns Promise<void>
Завершается, когда все подключения закрыты и логи сохранены
Example
```
await bot.getAppContext().close(); // при завершении работы приложения
```
- Defined in core/AppContext.ts:377

log

log(...args: unknown[]): void
Логирование информации

⚠️ Секреты не маскируются. В отличие от logError / logWarn / logMetric, этот метод НЕ прогоняет аргументы через конвейер маскирования — они уходят в логгер как есть. Предназначен для операционных сообщений (статус сервера, метрики старта). Никогда не передавайте сюда токены, пароли и другие секреты; для диагностики с метаданными используйте logWarn/logError.
Parameters
- ...args: unknown[]
  Аргументы для логирования
Returns void
Example
```
ctx.log('Запрос обработан за', 42, 'мс');
ctx.log({ userId: '123', command: 'start' });
```
- Defined in core/AppContext.ts:706

logError

logError(str: string, meta?: Record<string, unknown>): void
Логирование ошибки
Parameters
- str: string
  Текст ошибки
- Optionalmeta: Record<string, unknown>
  Дополнительные метаданные
Returns void
Example
```
ctx.logError('Ошибка подключения к БД', { host: 'localhost', error: err.message });
```
- Defined in core/AppContext.ts:724

logMetric

logMetric(name: string, value: unknown, label: Record<string, unknown>): void
Логирование метрики

Имя метрики и label проходят тот же конвейер маскирования секретов, что и logError/logWarn: в label может попасть, например, полный URL запроса, а для Telegram он содержит токен бота (https://api.telegram.org/bot<ТОКЕН>/...), который не должен попасть в системы наблюдаемости.
Parameters
- name: string
  имя метрики
- value: unknown
  значение
- label: Record<string, unknown>
  Дополнительные метаданные
Returns void
Example
```
ctx.logMetric('GET_COMMAND', 0.42, { platform: 'alisa', command: 'weather' });
ctx.logMetric('DB_SELECT', 12.5, { table: 'UsersData' });
```
- Defined in core/AppContext.ts:771

logWarn

logWarn(str: string, meta?: Record<string, unknown>): void
Логирование предупреждения
Parameters
- str: string
  Текст предупреждения
- Optionalmeta: Record<string, unknown>
  Дополнительные метаданные
Returns void
Example
```
ctx.logWarn('Текст обрезан до 1024 символов', { original: longText, truncated: shortText });
```
- Defined in core/AppContext.ts:861

saveFileData

saveFileData(fileName: string, data: unknown): Promise<boolean>
Сохраняет данные в JSON файл
Parameters
- fileName: string
  Имя файла
- data: unknown
  Данные для сохранения
Returns Promise<boolean>
Promise — true в случае успешного сохранения
Example
```
const saved = await ctx.saveFileData('config.json', { key: 'value' });
if (saved) console.log('Данные сохранены');
```
- Defined in core/AppContext.ts:886

setAppConfig

setAppConfig(config: Partial<IAppConfig>): void
Устанавливает конфигурацию приложения
Parameters
- config: Partial<IAppConfig>
  Пользовательская конфигурация
Returns void
Example
```
ctx.setAppConfig({ error_log: './logs', json: './data' });
```
- Defined in core/AppContext.ts:600

setLogger

setLogger(logger: ILogger | null): void
Позволяет установить свою реализацию для логирования
Parameters
- logger: ILogger | null
  Экземпляр логгера или null для отключения
Returns void
Example
```
ctx.setLogger({ error: (msg, meta) => console.error(msg, meta) });
```
- Defined in core/AppContext.ts:680

setPlatformParams

setPlatformParams(params: IAppParam): void
Устанавливает параметры приложения
Parameters
- params: IAppParam
  Пользовательские параметры
Returns void
Example
```
ctx.setPlatformParams({ welcome_text: 'Привет!', help_text: 'Список команд…' });
```
- Defined in core/AppContext.ts:642

Class AppContext<TDbInfo, TQuery>

Remarks

Example

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns AppContext<TDbInfo, TQuery>

Properties

appConfig

appMode

command

database

Type Declaration

Optionaladapter?: IDatabaseAdapter

OptionaldatabaseInfo?: TDbInfo

OptionalisSendConnect?: boolean

httpClient

Example

platformParams

platforms

plugins

Accessors

commands

Returns Map<string, ICommandParam<BotController<IUserData, IPlatformData>>>

regexpGroup

Returns Map<string, IGroupData>

steps

Returns Map<string, IStepParam<BotController<IUserData, IPlatformData>>>

usedMetric

Returns boolean

Example

Methods

close

Returns Promise<void>

Example

log

Parameters

Returns void

Example

logError

Parameters

Returns void

Example

logMetric

Parameters

Returns void

Example

logWarn

Parameters

Returns void

Example

saveFileData

Parameters

Returns Promise<boolean>

Example

setAppConfig

Parameters

Returns void

Example

setLogger

Parameters

Returns void

Example

setPlatformParams

Parameters

Returns void

Example

Settings

On This Page

`Optional`adapter?: IDatabaseAdapter

`Optional`databaseInfo?: TDbInfo

`Optional`isSendConnect?: boolean