Class SoundTokens

queryData

startIndex

state

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

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

add

• add(): Promise<boolean>

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

  Returns Promise<boolean>

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

  Example

  model.state.name = 'John';
  await model.add();
  Copy

destroy

• destroy(): void | Promise<void>

  Закрывает соединение с базой данных

  Returns void | Promise<void>

  Example

  model.destroy();
  Copy

escapeString

• escapeString(text: string | number): string

  Экранирует специальные символы в строке

  Parameters

  • text: string | number

    Строка или число для экранирования

  Returns string

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

  Example

  const safe = model.escapeString("O'Connor");
  Copy

init

• init(data: IDbResult<unknown> | IDbResult<unknown>[] | null): void

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

  Parameters

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

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

  Returns void

  Example

  // Объект: значения сопоставляются по именам полей (меткам attributeLabels)
  model.init({
    id: 1,
    username: 'John',
    age: 25
  });
  Copy

isConnected

• isConnected(): boolean | Promise<boolean>

  Проверяет состояние подключения к базе данных

  Returns boolean | Promise<boolean>

  true если подключение активно (синхронно false без адаптера БД, иначе Promise от адаптера)

  Example

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

query

• query(callback: TQueryCb): unknown

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

  Типы client/db зависят от подключённого адаптера БД — для MongoAdapter это MongoClient и Db из драйвера mongodb. Для FileAdapter _query не реализован — метод вернёт null.

  Parameters

  • callback: TQueryCb

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

  Returns unknown

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

  Example

  import type { MongoClient, Db } from 'mongodb';
  
  const result = await model.query(async (client: MongoClient, db: Db) => {
    const collection = db.collection('users');
    return await collection.aggregate([
      { $match: { age: { $gt: 18 } } },
      { $group: { _id: '$city', count: { $sum: 1 } } }
    ]).toArray();
  });
  Copy

remove

• remove(): Promise<boolean>

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

  Returns Promise<boolean>

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

  Example

  await model.remove();
  Copy

save

• save(isNew?: boolean): Promise<boolean>

  Сохраняет данные модели в базу данных Если запись существует - обновляет, иначе создает новую

  Parameters

  • isNew: boolean = false

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

  Returns Promise<boolean>

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

  Example

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

update

• update(): Promise<boolean>

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

  Returns Promise<boolean>

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

  Example

  model.state.name = 'John';
  await model.update();
  Copy

validate

• validate(): void

  Выполняет валидацию данных модели Может быть переопределен в дочерних классах

  Returns void

  Example

  validate(): void {
    if (!this.state.username) {
      throw new Error('Username is required');
    }
  }
  Copy

where

• where(
      where?: string | IQueryData,
      isOne?: boolean,
  ): Promise<IModelRes<IDataValue>>

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

  Parameters

  • where: string | IQueryData = '1'

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

  • isOne: boolean = false

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

  Returns Promise<IModelRes<IDataValue>>

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

  Example

  // Объект условий — точные значения полей
  const res = await model.where({ age: 25 });
  
  // Строка условий формата getQueryData
  const res2 = await model.where('`age`=25 `status`="active"');
  Copy

whereOne

• whereOne(where?: string | IQueryData): Promise<boolean>

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

  Parameters

  • where: string | IQueryData = '1'

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

  Returns Promise<boolean>

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

  Example

  const found = await model.whereOne({ id: 1 });
  if (found) {
    console.log('Запись найдена');
  }
  Copy