Class mmApp

Статический класс, хранящий состояние и параметры приложения.

Hierarchy

  • mmApp

Constructors

constructor

Properties

appType config isSaveDb params userDbController

Accessors

isDevMode

Methods

arrayMerge saveData saveJson saveLog setConfig setDevMode setIsSaveDb setParams

Constructors

constructor

Properties

Static appType

appType: null | TAppType

Тип приложения. (Алиса, бот vk|telegram).

Static config

config: IAppConfig = ...

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

Static isSaveDb

isSaveDb: boolean = false

Куда сохраняются пользовательские данные. Если false, то данные сохраняются в файл, иначе в бд. По умолчанию false.

Default Value

false

Static params

params: IAppParam = ...

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

Static userDbController

userDbController: IDbControllerModel

Использование стороннего контроллера для подключения к БД. Класс должен быть унаследован от DbControllerModel. Стоит применять в том случае, если используется другая СУБД. Если опция не передается, то используется стандартное подключение MongoDb.

See

DbControllerModel

Accessors

Static isDevMode

  • get isDevMode(): boolean

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

    Default Value

    false

    Returns boolean

Methods

Static arrayMerge

  • Объединение 2 массивов.

    Returns

    object

    Api

    Parameters

    • array1: object[]

      Массив с котором необходимо объединить значение.

    • Optional array2: object[]

      Массив для объединения.

    Returns object

Static saveData

  • Сохранение данных в файл. В случае если директории не существует, попытается ее создать.

    Parameters

    • dir: IDir

      Объект с путем и названием файла

    • data: string

      Сохраняемые данные

    • Optional mode: string

      Режим записи

    Returns boolean

Static saveJson

  • Сохранение данных в json файл.

    Returns

    boolean

    Api

    Parameters

    • fileName: string

      Название файла.

    • data: any

      Сохраняемые данные.

    Returns boolean

Static saveLog

  • Сохранение логов.

    Returns

    boolean

    Api

    Parameters

    • fileName: string

      Название файла.

    • errorText: null | string = ''

      Текст ошибки.

    Returns boolean

Static setConfig

  • Инициализация конфигурации приложения.

    Api

    Parameters

    • config: IAppConfig

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

    Returns void

Static setDevMode

  • Установить dev режим работы приложения. При его активации, в консоли будут отображаться все ошибки и предупреждения.

    Parameters

    • isDevMode: boolean = false

    Returns void

Static setIsSaveDb

  • Переопределения места, для хранения данных пользователя.

    Parameters

    • isSaveDb: boolean = false

      Если true, то данные сохраняются в БД, иначе в файл.

    Returns void

Static setParams

  • Инициализация параметров приложения.

    Api

    Parameters

    • params: IAppParam

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

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc