hs.task

Создает новый объект hs.task

• launchPath — Строка, содержащая путь к исполняемому файлу. Это должен быть полный путь к исполняемому файлу, а не просто исполняемый файл, который находится в пути вашей среды (например, /bin/ls вместо просто ls).
• callbackFn — Функция обратного вызова, которая будет вызываться при завершении задачи или nil, если вызов обратного вызова не требуется. Функция должна принимать три аргумента:
  • exitCode — Целое число, содержащее код завершения процесса
  • stdOut — Строка, содержащая стандартный вывод процесса
  • stdErr — Строка, содержащая стандартный вывод ошибок процесса
• streamCallbackFn — Необязательная функция обратного вызова, которая будет вызываться всякий раз, когда задача выводит данные в stdout или stderr. Функция должна возвращать логическое значение — true, чтобы продолжить вызов обратного вызова потока, false, чтобы остановить его вызов. Функция должна принимать три аргумента:
  • task — Объект hs.task или nil, если это окончательный вывод завершенной задачи.
  • stdOut — Строка, содержащая стандартный вывод, полученный с момента последнего вызова этого обратного вызова
  • stdErr — Строка, содержащая стандартный вывод ошибок, полученный с момента последнего вызова этого обратного вызова
• arguments — Необязательная таблица строк аргументов командной строки для исполняемого файла

• Объект hs.task

• Аргументы не обрабатываются через оболочку, поэтому вам не нужно выполнять цитирование или экранирование. Они передаются исполняемому файлу точно так, как предоставлены.
• При использовании обратного вызова потока обратный вызов может быть вызван один последний раз после того, как уже был вызван обратный вызов завершения. В этом случае аргумент task обратного вызова потока будет nil, а не объектом пользовательских данных задачи, и значение возврата обратного вызова потока будет проигнорировано.

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

• Нет

• Объект hs.task

• Это следует вызывать только для задач с обратным вызовом потока — задачи без него автоматически закроют stdin, когда все данные, предоставленные через hs.task:setInput(), будут записаны
• Это в первую очередь полезно для отправки EOF в длительно работающие задачи

Возвращает переменные окружения в виде таблицы для задачи.

• Нет

• таблица переменных окружения для задачи, где каждый ключ — имя переменной окружения.

• если вы ещё не установили таблицу окружения с помощью метода hs.task:setEnvironment, этот метод вернёт копию таблицы окружения Hammerspoon, поскольку именно её задача будет наследовать по умолчанию.

Прерывает задачу

• Нет

• объект hs.task

• Это отправит SIGINT процессу

Проверка, работает ли задача.

• Нет

• true, если задача выполняется, или false, если нет.

• Задача, которая ещё не запущена, также вернёт false.

Приостанавливает задачу

• Нет

• Если задача была успешно приостановлена, возвращает объект задачи; иначе возвращает false

• Если задача не приостановлена, сообщение об ошибке будет выведено в консоль Hammerspoon
• Этот метод можно вызывать несколько раз, но потребуется соответствующее количество вызовов hs.task:resume() для продолжения процесса

Получение PID запущенной/завершенной задачи

• Нет

• Целое число, содержащее PID задачи

• PID по-прежнему будет возвращён, если задача уже завершена и процесс завершён

Возобновляет задачу

• Нет

• Если задача была успешно возобновлена, возвращает объект задачи; иначе возвращает false

• Если задача не возобновлена успешно, сообщение об ошибке будет выведено в консоль Hammerspoon

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

• fn - функция, которая вызывается при завершении или прерывании задачи, или nil для удаления существующего обработчика

• объект hs.task

Установка переменных окружения для задачи.

• environment - таблица пар «ключ-значение», представляющих переменные окружения, которые будут установлены для задачи.

• объект hs.task или false, если таблица не была установлена (обычно потому, что задача уже запущена или завершена)

• Если вы не устанавливаете таблицу окружения с помощью этого метода, задача будет наследовать переменные окружения приложения Hammerspoon. Установите это в пустую таблицу, если вы хотите, чтобы для задачи не были установлены никакие переменные.

Устанавливает стандартные входные данные для задачи

• inputData - Данные в строковом формате, передаваемые задаче в качестве стандартного ввода

• Объект hs.task

• Этот метод может быть вызван до запуска задачи, чтобы подготовить некоторый ввод для неё (особенно если это не потоковая задача)
• Если этот метод вызывается несколько раз, любой ввод, который ещё не был передан задаче, игнорируется (для потоковых задач данные обычно потребляются очень быстро, но пока нет способа синхронизировать это)

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

• fn - Функция, которая будет вызываться, когда задача выводит данные в stdout или stderr, или nil для удаления обратного вызова

• Объект hs.task

• Для получения информации о требованиях к функции обратного вызова см. hs.task.new()
• Если обратный вызов удаляется без предварительного возвращения false, любые дальнейшие выводы stdout/stderr от задачи будут молча отброшены

Устанавливает рабочую директорию для задачи.

• path - строка, содержащая путь, который должен быть рабочей директорией для задачи.

• Объект hs.task или false, если рабочая директория не была установлена (обычно потому, что задача уже запущена или завершена)

• Вы можете установить рабочую директорию только если задача ещё не запущена.
• Это установит только директорию, в которой задача начнёт работу. Сама задача может изменить директорию во время выполнения.

Запускает задачу

• Нет

• Если задача была запущена успешно, возвращает объект задачи; в противном случае возвращает false

• Если задача не запущена успешно, сообщение об ошибке будет выведено в консоль Hammerspoon

Прерывает задачу

• Нет

• Объект hs.task

• Это отправит SIGTERM в процесс

Возвращает причину завершения задачи или false, если задача всё ещё выполняется.

• Нет

• строковое значение "exit", если процесс завершился нормально, или "interrupt", если он был убит сигналом. Возвращает false, если причина завершения недоступна (задача всё ещё выполняется или ещё не была запущена).

Возвращает состояние завершения задачи, или false, если задача всё ещё выполняется.

• Нет

• числовой exitCode задачи или булево значение false, если задача ещё не завершена (либо потому, что она ещё не запущена, либо потому, что она всё ещё выполняется).

Блокирует Hammerspoon до завершения задачи

• Нет

• Объект hs.task

• Вся активность Lua и Hammerspoon будет заблокирована этим методом. Его использование крайне не рекомендуется.

Возвращает рабочую директорию для задачи.

• Нет

• строка, содержащая рабочую директорию для задачи.

• Это возвращает только директорию, в которой задача начинает работу. Если задача сама меняет директорию, это значение не будет отражать это изменение.