umbot
    Preparing search index...

    Модель для управления изображениями в различных платформах. Предоставляет единый интерфейс для работы с изображениями в Алисе, ВКонтакте, Telegram, Марусе и тд.

    ImageTokens

    // Создание и загрузка изображения для Telegram
    const image = new ImageTokens();
    sound.path = '/path/to/image.png';
    sound.platform = T_TELEGRAM;
    const token = await image.selectOne();
    if (token) {
    console.log('Токен для изображения успешно получен, токен:', token);
    } else {
    || Загрузка изображения
    }

    Hierarchy (View Summary)

    Index

    Constructors

    • Конструктор класса ImageTokens. Предоставляет унифицированный интерфейс для хранения данных о загруженных изображений.

      Parameters

      • appContext: AppContext

      Returns ImageTokens

    Properties

    _appContext: AppContext

    Контекст приложения.

    caption: string | null

    Описание изображения (Не обязательное поле). Используется как подпись к изображению в некоторых платформах.

    queryData: IQuery

    Объект для хранения параметров запроса. Содержит условия поиска и данные для обновления

    startIndex: number = 0

    Начальный индекс для итерации по данным. Используется при инициализации модели из массива

    state: Partial<TState> = {}

    Состояние модели. Содержит текущие значения всех атрибутов

    // Установка значений
    this.state.username = 'John';
    this.state.age = 25;

    // Получение значений
    console.log(this.state.username);

    Accessors

    • get imageToken(): string

      Идентификатор/токен изображения. Уникальный идентификатор, используемый для ссылки на изображение в API платформы.

      Returns string

    • set imageToken(imageToken: string | null): void

      Устанавливает идентификатор/токен изображения.

      Parameters

      • imageToken: string | null

      Returns void

    • get path(): string

      Расположение изображения (url/директория). Может быть URL-адресом изображения или путем к локальному файлу.

      Returns string

    • set path(path: string | null): void

      Устанавливает расположение изображения (url/директория).

      Parameters

      • path: string | null

      Returns void

    • get platform(): string

      Тип приложения, для которого загружена картинка.

      Returns string

    • set platform(platform: string): void

      Устанавливает тип приложения, для которого загружена картинка.

      Parameters

      • platform: string

      Returns void

    Methods

    • Добавляет новую запись в базу данных

      Returns Promise<boolean>

      Promise с результатом операции

      model.state.name = 'John';
      await model.add();
    • Экранирует специальные символы в строке

      Parameters

      • text: string | number

        Текст для экранирования

      Returns string

      Экранированная строка

      const safe = model.escapeString("O'Connor");
      
    • Определяет имя первичного ключа таблицы. Ищет поле с меткой 'id' или 'ID'

      Returns TKey

      Имя первичного ключа или null

    • Инициализирует модель данными

      Parameters

      • data: IDbResult<unknown> | IDbResult<unknown>[] | null

        Данные для инициализации

      Returns void

      model.init({
      id: 1,
      username: 'John',
      age: 25
      });
    • Проверяет состояние подключения к базе данных

      Returns boolean | Promise<boolean>

      Promise - true если подключение активно

      const isConnected = await model.isConnected();
      if (isConnected) {
      // Выполнение операций с базой данных
      }
    • Выполняет произвольный запрос к базе данных

      Parameters

      • callback: TQueryCb

        Функция обратного вызова для выполнения запроса

      Returns unknown

      Результат выполнения запроса

      const result = await model.query(async (client, db) => {
      const collection = db.collection('users');
      return await collection.aggregate([
      { $match: { age: { $gt: 18 } } },
      { $group: { _id: '$city', count: { $sum: 1 } } }
      ]).toArray();
      });
    • Удаляет запись из базы данных

      Returns Promise<boolean>

      Promise - true если удаление успешно

      await model.remove();
      
    • Сохраняет данные модели в базу данных Если запись существует - обновляет, иначе создает новую

      Parameters

      • isNew: boolean = false

        Флаг создания новой записи

      Returns Promise<boolean>

      Promise с результатом операции

      model.state.name = 'John';
      await model.save(); // Обновление существующей записи
      await model.save(true); // Создание новой записи
    • Возвращает название таблицы/файла с данными.

      Returns string

      Название таблицы для хранения данных об изображениях

    • Обновляет существующую запись в базе данных

      Returns Promise<boolean>

      Promise с результатом операции

      model.state.name = 'John';
      await model.update();
    • Выполняет валидацию данных модели Может быть переопределен в дочерних классах

      Returns void

      validate(): void {
      if (!this.state.username) {
      throw new Error('Username is required');
      }
      }
    • Выполняет произвольный запрос к базе данных

      Parameters

      • where: string | IQueryData = '1'

        Условия запроса

      • isOne: boolean = false

        Флаг выборки одной записи

      Returns Promise<IModelRes<IDataValue>>

      Promise с результатом запроса

    • Выполняет запрос с выборкой одной записи

      Parameters

      • where: string | IQueryData = '1'

        Условия запроса

      Returns Promise<boolean>

      Promise - true если запись найдена

      const found = await model.whereOne({ id: 1 });
      if (found) {
      console.log('Record found');
      }