hs.task - Hammerspoon 2 API

Module for running external processes

Types

This module provides the following types:

function | null

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

function | null

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	function \| null	Optional callback called when the task terminates with exit code and reason
environment	[String: String]	Optional dictionary of environment variables for the task
streamingCallback	function \| null	Optional callback called when the task produces output; stream is "stdout" or "stderr"

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, 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
legacyStreamCallback	Function	- Legacy streaming callback (optional)