Class AppContext

constructor

• new AppContext(): AppContext

  Returns AppContext

userDbController

isSaveDb

false
Copy

appType

appConfig

platformParams

httpClient

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

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

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;
  }
};
Copy

commands

vDB

• get vDB(): DB

  Получить текущее подключение к базе данных

  Returns DB

isDevMode

• get isDevMode(): boolean

  Возвращает текущий режим работы приложения

  Returns boolean

  true, если включен режим разработки

closeDB

• closeDB(): void

  Закрыть подключение к базе данных

  Returns void

setDevMode

• setDevMode(isDevMode?: boolean): void

  Устанавливает режим разработки

  Parameters

  • isDevMode: boolean = false

    Флаг включения режима разработки

  Returns void

  Remarks

  В режиме разработки в консоль выводятся все ошибки и предупреждения

setAppConfig

• setAppConfig(config: IAppConfig): void

  Устанавливает конфигурацию приложения

  Parameters

  • config: IAppConfig

    Пользовательская конфигурация

  Returns void

setPlatformParams

• setPlatformParams(params: IAppParam): void

  Устанавливает параметры приложения

  Parameters

  • params: IAppParam

    Пользовательские параметры

  Returns void

addCommand

• addCommand<
      TBotController extends
          BotController<IUserData> = BotController<IUserData>,
  >(
      commandName: string,
      slots: string[],
      cb?: (userCommand: string, botController: TBotController) => string | void,
      isPattern?: boolean,
  ): void

  Добавляет команду для обработки пользовательских запросов

  Type Parameters

  • TBotController extends BotController<IUserData> = BotController<IUserData>

  Parameters

  • commandName: string

    Уникальный идентификатор команды
  • slots: string[]

    Триггеры для активации команды
  • Optionalcb: (userCommand: string, botController: TBotController) => string | void

    Функция-обработчик команды
  • isPattern: boolean = false

    Использовать регулярные выражения (по умолчанию false)

  Returns void

  Example

  Простая команда со словами:

  appContext.addCommand(
    'greeting',
    ['привет', 'здравствуй'],
    (cmd, ctrl) => {
      if (ctrl) ctrl.text = 'Здравствуйте!';
    }
  );
  Copy

  Example

  Команда с регулярными выражениями:

  // Обработка чисел от 1 до 999
  appContext.addCommand(
    'number',
    ['\\b([1-9]|[1-9][0-9]|[1-9][0-9][0-9])\\b'],
    (cmd, ctrl) => {
      if (ctrl) ctrl.text = `Вы ввели число: ${cmd}`;
    },
    true  // включаем поддержку регулярных выражений
  );
  Copy

  Example

  Команда с доступом к состоянию:

  appContext.addCommand(
    'stats',
    ['статистика'],
    async (cmd, ctrl) => {
      if (ctrl) {
        // Доступ к пользовательским данным
        const visits = ctrl.userData?.visits || 0;
        ctrl.text = `Вы использовали бота ${visits} раз`;
  
        // Доступ к кнопкам и другим UI элементам
        ctrl.buttons
          .addBtn('Сбросить статистику')
          .addBtn('Закрыть');
      }
    }
  );
  Copy

  Remarks

  • Команды обрабатываются в порядке добавления
  • При isPattern=true используются регулярные выражения JavaScript
  • В callback доступен весь функционал BotController
  • Можно использовать async функции в callback

removeCommand

• removeCommand(commandName: string): void

  Удаляет команду

  Parameters

  • commandName: string

    Имя команды

  Returns void

clearCommands

• clearCommands(): void

  Удаляет все команды

  Returns void

setLogger

• setLogger(logger: null | ILogger): void

  Позволяет установить свою реализацию для логирования

  Parameters

  • logger: null | ILogger

  Returns void

logError

• logError(str: string, meta?: Record<string, unknown>): void

  Логирование ошибки

  Parameters

  • str: string
  • Optionalmeta: Record<string, unknown>

  Returns void

logWarn

• logWarn(str: string, meta?: Record<string, unknown>): void

  Логирование предупреждения

  Parameters

  • str: string
  • Optionalmeta: Record<string, unknown>

  Returns void

setIsSaveDb

• setIsSaveDb(isSaveDb?: boolean): void

  Устанавливает способ хранения пользовательских данных

  Parameters

  • isSaveDb: boolean = false

    true для сохранения в БД, false для сохранения в файл

  Returns void

saveJson

• saveJson(fileName: string, data: any): boolean

  Сохраняет данные в JSON файл

  Parameters

  • fileName: string

    Имя файла
  • data: any

    Данные для сохранения

  Returns boolean

  true в случае успешного сохранения

saveLog

• saveLog(fileName: string, errorText?: null | string): boolean

  Сохраняет лог ошибки

  Parameters

  • fileName: string

    Имя файла лога
  • errorText: null | string = ''

    Текст ошибки

  Returns boolean

  true в случае успешного сохранения