hs.task - Hammerspoon 2 API

Module for running external processes

Types

This module provides the following types:

JSValue

Run a task, returning a Promise. Swift-retained storage for the JS implementation.

JSValue

Run a shell command. Swift-retained storage for the JS implementation.

JSValue

Run multiple tasks in parallel. Swift-retained storage for the JS implementation.

JSValue

Run multiple tasks in sequence. Swift-retained storage for the JS implementation.

JSValue

Create a task builder. Swift-retained storage for the JS implementation.

JSValue

TaskBuilder class. Swift-retained storage for the JS implementation.

Create a new task

Declaration

hs.task.create(launchPath, arguments, completionCallback, environment, streamingCallback) -> HSTask

Parameters

Name	Type	Description
launchPath	string	The full path to the executable to run
arguments	string[]	An array of arguments to pass to the executable
completionCallback	JSValue	Optional callback function called when the task terminates
environment	JSValue	Optional dictionary of environment variables for the task
streamingCallback	JSValue	Optional callback function called when the task produces output

Returns

HSTask

A task object. Call start() to begin execution.

Example

const task = hs.task.create("/usr/bin/env", ["printenv", "PATH"], (code, reason) => {
    console.log("exited", code)
})
task.start()

Create and run a task asynchronously

Declaration

hs.task.runAsync(launchPath, args, options, options, options, options, legacyStreamCallback) -> any

Parameters

Name	Type	Description
launchPath	string	- Full path to the executable
args	string[]	- Array of arguments
options	Object\|Function	- Options object or legacy callback
options	Object	.environment - Environment variables (optional)
options	string	.workingDirectory - Working directory (optional)
options	Function	.onOutput - Callback for streaming output: (stream, data) => {} (optional)
legacyStreamCallback	Function	- Legacy streaming callback (optional)