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

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

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

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

Create and run a task asynchronously

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

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)