Class ModelAbstract

Hierarchy

Implements

Constructors

constructor

Properties

dbController queryData startIndex

Methods

add attributeLabels destroy escapeString getId init isConnected query remove rules save selectOne tableName update validate where whereOne

Constructors

Protected constructor

Properties

dbController

dbController: IDbControllerModel

queryData

queryData: QueryData

startIndex

startIndex: number = 0

Стартовое значение для индекса.

Methods

add

  • Добавление значения в таблицу.

    Returns

    Api

    Returns Promise<any>

Abstract attributeLabels

  • Массив с полями таблицы, где ключ это название поля, а значение краткое описание. Для уникального ключа использовать значение ID.

    Returns

    object

    Returns ILabelAttr

destroy

escapeString

  • Декодирование текста(Текст становится приемлемым и безопасным для sql запроса).

    Returns

    string

    Api

    Parameters

    • text: string | number

      Исходный текст.

    Returns string

Protected getId

  • Возвращаем название уникального ключа таблицы.

    Returns

    number|string

    Returns null | string | number

init

isConnected

  • Проверка подключения к источнику данных. При использовании БД, проверяется статус подключения. Если удалось подключиться, возвращается true, в противном случае false. При сохранении данных в файл, всегда возвращается true.

    Returns

    Returns Promise<boolean>

query

  • Выполнение произвольного запрос к базе данных.

    Returns

    Api

    Parameters

    • callback: Function

      Непосредственно запрос к бд.

    Returns any

remove

  • Удаление значения из таблицы.

    Returns

    Api

    Returns Promise<boolean>

Abstract rules

  • Правила для обработки полей. Где 1 - Элемент это название поля, 2 - Элемент тип поля, max - Максимальная длина.

    Returns

    IModelRules[]

    Returns IModelRules[]

save

  • Сохранение значения в базу данных. Если значение уже есть в базе данных, то данные обновятся. Иначе добавляется новое значение.

    Returns

    Api

    Parameters

    • isNew: boolean = false

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

    Returns Promise<any>

selectOne

Abstract tableName

  • Название таблицы/файла с данными.

    Returns

    string

    Returns string

update

  • Обновление значения в таблице.

    Returns

    Api

    Returns Promise<any>

validate

  • Валидация значений полей для таблицы.

    Api

    Returns void

where

  • Выполнение запроса к данным.

    Returns

    Api

    Parameters

    • where: any = '1'

      Запрос к таблице.

    • isOne: boolean = false

      Вывести только 1 результат. Используется только при поиске по файлу.

    Returns Promise<IModelRes>

whereOne

  • Выполнение запроса и инициализация переменных в случае успешного запроса.

    Returns

    Api

    Parameters

    • where: any = '1'

      Запрос к таблице.

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc