Interface Interactive

Task Context definition.

interface Interactive {
    args: string[];
    cancellation: AbortSignal;
    cwd: string;
    env: Dictionary<null | string>;
    level: LogLevel;
    prefix: boolean | PrefixPolicy;
    route: string[];
    stdio: [ReadStream, WriteStream, null | Writable];
}

Hierarchy (view full)

Properties

args cancellation cwd env level prefix route stdio

Properties

Readonlyargs

args: string[]

A task's arguments. Used for spawned processes.

Readonlycancellation

cancellation: AbortSignal

An AbortSignal for task cancellation. Tasks should cancel when it emits.

Readonlycwd

cwd: string

A task's working directory. Used as root for paths in file operations and for spawned processes.

Readonlyenv

env: Dictionary<null | string>

A task's environment variables. Used for spawned processes.

Readonlylevel

level: LogLevel

A task's log level.

Readonlyprefix

prefix: boolean | PrefixPolicy

Whether a task will prefix all lines of its stdout and stderr writes with the stringification of its route.

Readonlyroute

route: string[]

A task's route.

Readonlystdio

stdio: [ReadStream, WriteStream, null | Writable]

A task's stdin, stdout and stderr.

Settings

Member Visibility

On This Page

Properties