Class TaskBuilder

TaskBuilder class for fluent task construction

Index

Constructors

Methods

build inDirectory onOutput run withArgs withEnvironment

Constructors

constructor

new TaskBuilder(): TaskBuilder
Returns TaskBuilder

Methods

build

build(): HSTask
Build the task without running

Returns HSTask
The created task, not yet started

inDirectory

inDirectory(directory: string): TaskBuilder
Set working directory
Parameters
- directory: string
  Working directory path
Returns TaskBuilder
This builder, for chaining

onOutput

onOutput(callback: Function): TaskBuilder
Set output callback
Parameters
- callback: Function
  Output callback (stream, data) => {}
Returns TaskBuilder
This builder, for chaining

run

run(): Promise<{ exitCode: number; stderr: string; stdout: string }>
Build and run the task

Returns Promise<{ exitCode: number; stderr: string; stdout: string }>
The task's result

withArgs

withArgs(...args: string[]): TaskBuilder
Add arguments
Parameters
- ...args: string[]
  Arguments to add
Returns TaskBuilder
This builder, for chaining

withEnvironment

withEnvironment(environment: Object): TaskBuilder
Set environment variables
Parameters
- environment: Object
  Environment variables
Returns TaskBuilder
This builder, for chaining