TaskBuilder
TypeTaskBuilder class for fluent task construction
Properties
This type has no properties.
Methods
withArgs(args) -> TaskBuilder
Add arguments
Declaration
withArgs(args) -> TaskBuilderParameters
| Name | Type | Description |
|---|---|---|
| args | string[] | - Arguments to add |
Returns
TaskBuilder
This builder, for chaining
withEnvironment(environment) -> TaskBuilder
Set environment variables
Declaration
withEnvironment(environment) -> TaskBuilderParameters
| Name | Type | Description |
|---|---|---|
| environment | Object | - Environment variables |
Returns
TaskBuilder
This builder, for chaining
inDirectory(directory) -> TaskBuilder
Set working directory
Declaration
inDirectory(directory) -> TaskBuilderParameters
| Name | Type | Description |
|---|---|---|
| directory | string | - Working directory path |
Returns
TaskBuilder
This builder, for chaining
onOutput(callback) -> TaskBuilder
Set output callback
Declaration
onOutput(callback) -> TaskBuilderParameters
| Name | Type | Description |
|---|---|---|
| callback | Function | - Output callback (stream, data) => {} |
Returns
TaskBuilder
This builder, for chaining
run() -> Promise<{exitCode: number, stdout: string, stderr: string}>
Build and run the task
Declaration
run() -> Promise<{exitCode: number, stdout: string, stderr: string}>Returns
Promise<{exitCode: number, stdout: string, stderr: string}>
The task's result
build() -> HSTask
Build the task without running
Declaration
build() -> HSTaskReturns
HSTask
The created task, not yet started