Xauto API

Xauto

async Xauto([options])

Асинхронное создание объекта Xauto и выполнение последующих операций:

1. Создание создателя Xauto
2. Загрузка предварительно загруженных плагинов
3. Создание создателя предварительно настроенной конфигурации
4. Создание задачи предварительно настроенной конфигурации
5. Создание монитора предварительно настроенной конфигурации
6. Выполнение автоматической задачи (не ждет завершения задачи)
7. Начало слежения за автоматически запущенным монитором
8. Выполнение автоматического скрипта
9. Если в скрипте имеются экспортированные функции, созданный объект Xauto передается как аргумент этих функций

Допустимые опции [options]:* opt {Object} — опциональный конфигурационный объект, который использует значения по умолчанию для каждого плагина; подробнее см. описание каждого плагина

• pkg {Object} — опциональный конфигурационный объект, содержащий информацию из файла package.json
• path {Object} — информация о путях, включая рабочий путь path.work и путь к плагинам path.plugin
• echo {Function} — опциональная функция вывода информации
• XBWP {String} — опциональная, будет удалена базовая рабочая директория Xauto; используйте вместо этого path.work
• XPBP {String} — опциональная, будет удалена базовая директория поиска плагинов Xauto; используйте вместо этого path.plugin
• plugin {Array} — опциональный список предварительно загруженных плагинов
• task {Object<описание задачи>} — опциональный предварительно настроенный объект задачи
• watcher {Object<описание монитора>} — опциональный предварительно настроенный объект монитора
• exec {Array} — опциональный список автоматических задач
• watch {Object<[монитор, задача]>} — опциональный автоматический запуск монитора
• script {String} — опциональный путь к автоматическому скрипту### новый Xauto([options])

Не рекомендуется использовать конструктор Xauto для создания объекта Xauto; лучше воспользоваться асинхронной функцией Xauto()

Допустимые опции [options]:

• opt {Object} — необязательный конфигурация плагинов, где используются значения по умолчанию для каждого плагина; подробнее см. описание каждого плагина
• pkg {Object} — необязательный конфигурация пакета, содержащая информацию из package.json
• path {Object} — информация о путях, включая рабочий путь path.work и путь к плагинам path.plugin
• echo {Function} — необязательный функция вывода информации
• XBWP {String} — необязательный, будет удалено базовый рабочий путь Xauto; используйте вместо этого path.work
• XPBP {String} — необязательный, будет удалено базовый путь поиска плагинов Xauto; используйте вместо этого path.plugin

xauto.opt

Только чтение Это свойство доступно только для чтения.

Конфигурация opt, переданная при создании объекта Xauto.

xauto.pkg

Только чтение Это свойство доступно только для чтения.Конфигурация pkg, переданная при создании объекта Xauto.### xauto.path только для чтения Это свойство доступно только для чтения
Путь, переданный при создании Xauto
Компоненты:

• work{String} - только для чтения рабочий путь
  Если это относительный путь, он будет преобразован в абсолютный путь с учётом рабочего пути объекта при его создании
• plugin{String} - только для чтения путь к плагинам
  Если это относительный путь, он будет преобразован в абсолютный путь с учётом рабочего пути XPBP###xauto.XBWP только для чтения Это свойство доступно только для чтения
  будет отключено Это свойство будет отключено в ближайшее время
  XBWP, переданное при создании Xauto
  Если это относительный путь, он будет преобразован в абсолютный путь с учётом рабочего каталога при создании объекта### xauto.XPBP только для чтения Это свойство доступно только для чтения
  будет отключен Это свойство будет отключено в ближайшее время
  XPBP переданное при создании Xauto
  Если это относительный путь, он будет преобразован в абсолютный путь с учётом XPBP

xauto.util

Набор инструментов, импортированных плагинами

async xauto.task(task, [name])

Асинхронная функция создания или получения Task

• task{описание задачи} — конфигурация для создания или получения задачи
• name{String} — необязательное имя регистрации

Примечание:

• Если значение является строкой, то это получение.
• В случае неудачи создания или получения задачи, вернётся null.

async xauto.watcher(watcher, [name])

Асинхронная функция создания или получения Watcher

• watcher{описание наблюдателя} — конфигурация для создания или получения наблюдателя
• name{String} — необязательное имя регистрации

Примечание:

• Если значение является строкой, то это получение.
• В случае неудачи создания или получения наблюдателя, вернётся null.

async xauto.watchState(name)

Асинхронная функция получения WatchState

• name{String} — имя состояния наблюдения

Примечание:

• В случае неудачи получения состояния наблюдения, вернётся null.### async xauto.creator(creator, [name]) Асинхронная функция создания или получения Creator(создателя).
• creator {описание создателя} — конфигурация для создания или получения создателя.
• name {строка} — необязательное имя регистрации.Примечание:
• Если значение является строкой, то это получение.
• В случае неудачи создания или получения создателя, вернётся null.

###async xauto.register(obj, name) Асинхронная функция регистрации Task(задачи)/Watcher(наблюдателя)/WatchState(состояния наблюдения)/Creator(создателя)

• obj{Task/Watcher/WatchState/Creator} - задача/наблюдатель/состояние наблюдения/создатель для регистрации
• name{String} - имя регистрации

Значение возврата указывает на успешность регистрации

###async xauto.plugin(name) Асинхронная функция загрузки плагина (плагины загружаются только один раз)

• name{String} - имя плагина

Значение возврата указывает на успешность загрузки

###async xauto.exec(task, [cfg, [context]]) Асинхронная функция выполнения задачи

• task{Task/String} - задача или имя задачи для выполнения
• cfg{any} - необязательное конфигурационное значение для задачи
• context{Context} - необязательное контекстное значение для выполнения задачи

Значение возврата представляет собой значение, возвращаемое задачей после завершения
xauto.exec() представляет собой внешний слой try...catch для task.exec(), в случае возникновения ошибки в task.exec(), она будет обработана, а затем возвращено undefined.

###async xauto.watch(watcher, task) Асинхронное начало мониторинга

• watcher{Watcher/String} - используемый монитор
• task{Task/String} - задача или имя задачи, активирующее выполнение мониторингаВозвращает состояние мониторинга

###xauto.Signal(signal), xauto.Signal.TYPE(signal) Синхронная фильтрация сигнала

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

Примечание:

• xauto.Signal(signal) и xauto.Signal.TYPE(signal) должны использоваться в начале блока catch.

###xauto.echo([options]) Синхронный вывод информации
Допустимые опции [options]:

• lv{String} - необязательная степень
• tp{String} - необязательная тип
• at{String} - необязательная плагин
• fn{String} - необязательная имя файла
• ln{Number} - необязательная номер строки
• cl{Number} - необязательная номер столбца
• tx{String} - необязательная сообщение об ошибке

###xauto.throw([options]) Синхронный вывод информации и завершение задачи Опции [options] такие же как для xauto.echo([options])

###xauto.exit() Синхронное завершение задачиОбщие черты и различия между xauto.echo(), xauto.throw() и xauto.exit():

• xauto.echo() и xauto.throw() оба выводят информацию, но xauto.throw() также бросает сигнал XautoSignal.Error. Этот сигнал может быть пойман и обработан плагинами или пользовательскими скриптами через try-catch. Если сигнал был пойман, информация не будет выведена.
• xauto.throw() и xauto.exit() оба используются для завершения задачи путём бросания подкласса сигнала XautoSignal. Эти сигналы могут быть пойманы и обработаны плагинами или пользовательскими скриптами через catch. Если сигнал был пойман, задача не будет завершена.
• Если не требуется ловить сигналы XautoSignal, можно использовать xauto.Signal для обработки сигнала в начале блока catch. Если требуется игнорировать определённый тип сигнала, можно использовать xauto.Signal.TYPE.## Контекст (соответствующий контекст) this при выполнении каждой функции имеет прототип xauto

Задача (задача)

Создается или получается с помощью xauto.task()

async task.exec([cfg, [context]])

Асинхронное выполнение задачи

• cfg {любой} - необязательная конфигурация задачи
• context {Context} - необязательная контекст this

Возвращает значение задачи

task.new([opt, [...args]])

Синхронное создание новой задачи на основе текущей задачи

• opt {Объект} - необязательная опции, добавленные к существующим опциям, повторяющиеся опции будут заменены новыми
• args {...any} - необязательные аргументы, добавленные после существующих аргументов

Возвращаемое значение представляет созданный задачей.

async task([cfg, [context]])

Краткая форма записи async task.exec([cfg, [context]])

new task([opt, [...args]])

Краткая форма записи async task.new([opt, [...args]])

Создатель (Создатель)

Используйте xauto.creator() для создания или получения

async creator.create(cfg)

Не рекомендуется асинхронное создание задачи

• cfg {Объект} — параметры задачи

Возвращает созданную задачу

creator.new([opt, [...args]])

Синхронное создание нового объекта на основе текущего создателя

• opt {Объект} — опциональные параметры, добавляемые к существующим параметрам; повторяющиеся параметры будут заменены новыми значениями
• args {...any} — опциональные аргументы, добавляемые после существующих аргументовВозвращает созданный создатель

async creator(cfg)

Краткая форма записи await creator.exec(cfg)

new creator([opt, [...args]])

Краткая форма записи new creator.new([opt, [...args]])

Наблюдатель (Watcher)

Используйте xauto.watcher() для создания или получения

async watcher.watch(task)

Асинхронное начало наблюдения

• task {Задача} — задача, которая будет отслеживаться при активации событий

Возвращает созданную задачу

watcher.new([opt, [...args]])

Синхронное создание нового объекта на основе текущего наблюдателя

• opt {Объект} — опциональные параметры, добавляемые к существующим параметрам; повторяющиеся параметры будут заменены новыми значениями
• args {...any} — опциональные аргументы, добавляемые после существующих аргументов

Возвращает созданный наблюдатель

async watcher(task)

Краткая форма записи await watcher.watch(task)

new watcher([opt, [...args]])

Краткая форма записи new watcher.new([opt, [...args]])

Состояние наблюдения (WatchState)

Используйте xauto.watchState() для получения или xauto.watch(watcher, task) для создания

async watchState.stop()

Асинхронное завершение наблюдения

async watchState()

Краткая форма записи await watchState.stop()