umbot
    Preparing search index...

    Interface IAppConfig

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

    Определяет основные настройки приложения, включая пути к директориям, конфигурацию базы данных, токены платформ и флаги режимов работы.

    const config: IAppConfig = {
      error_log: './logs',
      json: './data',
      db: {
        host: 'localhost',
        database: 'bot_db'
      },
      isLocalStorage: true,
      env: '.env'
    };
    interface IAppConfig {
        db?: IAppDB;
        env?: string;
        error_log?: string;
        isLocalStorage?: boolean;
        json?: string;
        memorySession?: false | IMemorySessionConfig;
        tokens?: ITokenPlatform;
    }
    Index

    Properties

    db? env? error_log? isLocalStorage? json? memorySession? tokens?

    Properties

    db?: IAppDB

    Конфигурация базы данных

    env?: string

    Путь к файлу с переменными окружения(.env). Если указан путь к .env-файлу, фреймворк попытается загрузить переменные из него. Если файл не найден — используются переменные из process.env. Также если передать значение local, то данные будут взяты из process.env

    error_log?: string

    Путь к директории для логов ошибок и предупреждений

    isLocalStorage?: boolean

    Флаг использования локального хранилища платформы. Перед включением флага убедитесь, что платформа поддерживает хранение данных в локальном хранилище. Также некоторые платформы требуют, чтобы была установлена соответствующая настройка у приложения.

    При указании опции в значение true фреймворк автоматически сохранит все данные из userData в платформу, также все данные от платформы записываются в userData. Рекомендуется использовать в том случае, если вам не нужна база данных.

    Если платформа не поддерживает локальное хранилище (Telegram, VK, MAX, Viber), данные хранятся в БД, а без DB-адаптера — в памяти процесса (см. memorySession). Сессия в памяти теряется при перезапуске и не разделяется между процессами и инстансами (кластер, serverless) — для надёжного хранения подключите БД.

    json?: string

    Путь к директории для JSON файлов

    memorySession?: false | IMemorySessionConfig

    Сессия userData в памяти процесса — аналог MemorySessionStorage у grammY.

    Используется только при isLocalStorage: true, если платформа не поддерживает локальное хранилище и DB-адаптер не подключён. По умолчанию: до 10 000 пользователей, данные живут 24 часа с последнего запроса пользователя. false — отключить (userData между запросами не сохраняется).

    Данные теряются при перезапуске процесса и не разделяются между процессами (кластер, несколько реплик, serverless) — в таких случаях подключите DB-адаптер.

    bot.setAppConfig({ isLocalStorage: true, memorySession: { maxSize: 50_000, ttl: 60 * 60 * 1000 } });
    tokens?: ITokenPlatform

    Список различных токенов. Стоит использовать в ситуациях, когда для корректной работы платформы, необходимо указывать токен. НЕ рекомендуется его как-либо заполнять автоматически, находясь вне адаптера платформы

    Settings

    Member Visibility

    On This Page

    Properties