Class Task`Abstract`

A Task represents the execution state of a TaskConfiguration. Implementing classes have to call the Task#fireOutputLine function whenever a new output occurs during the execution.

Hierarchy (View Summary)

Task
- CustomTask
- ProcessTask

Implements

Index

Constructors

Properties

exitEmitter logger options outputEmitter taskId taskManager toDispose

Accessors

context id label onExit onOutput

Methods

dispose fireOutputLine fireTaskExited getRuntimeInfo kill

Constructors

constructor

new Task(
    taskManager: ManagedTaskManager<Task>,
    logger: ILogger,
    options: TaskOptions,
): Task
Parameters
- taskManager: ManagedTaskManager<Task>
- logger: ILogger
- options: TaskOptions
Returns Task
- Defined in packages/task/src/node/task.ts:45

Properties

`Readonly`exitEmitter

exitEmitter: Emitter<TaskExitedEvent>

`Protected` `Readonly`logger

logger: ILogger

`Protected` `Readonly`options

options: TaskOptions

`Readonly`outputEmitter

outputEmitter: Emitter<TaskOutputEvent>

`Protected`taskId

taskId: number

`Protected` `Readonly`taskManager

taskManager: ManagedTaskManager<Task>

`Protected` `Readonly`toDispose

toDispose: DisposableCollection = ...

Accessors

context

get context(): undefined | string
Returns undefined | string
Implementation of ManagedTask.context
- Defined in packages/task/src/node/task.ts:92

id

get id(): number
Returns number
Implementation of ManagedTask.id
- Defined in packages/task/src/node/task.ts:88

label

get label(): string
Returns string
- Defined in packages/task/src/node/task.ts:96

onExit

get onExit(): Event<TaskExitedEvent>
Returns Event<TaskExitedEvent>
- Defined in packages/task/src/node/task.ts:64

onOutput

get onOutput(): Event<TaskOutputEvent>
Returns Event<TaskOutputEvent>
- Defined in packages/task/src/node/task.ts:68

Methods

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of Disposable.dispose
- Defined in packages/task/src/node/task.ts:100

`Protected`fireOutputLine

fireOutputLine(event: TaskOutputEvent): void
Parameters
- event: TaskOutputEvent
Returns void
- Defined in packages/task/src/node/task.ts:77

`Protected`fireTaskExited

fireTaskExited(event: TaskExitedEvent): void
Has to be called when a task has concluded its execution.
Parameters
- event: TaskExitedEvent
Returns void
- Defined in packages/task/src/node/task.ts:73

`Abstract`getRuntimeInfo

getRuntimeInfo(): MaybePromise<TaskInfo>
Retrieves the runtime information about this task. The runtime information computation may happen asynchronous.

Returns MaybePromise<TaskInfo>
(a promise of) the runtime information as TaskInfo.
- Defined in packages/task/src/node/task.ts:86

`Abstract`kill

kill(): Promise<void>
Terminate this task.

Returns Promise<void>
a promise that resolves once the task has been properly terminated.
- Defined in packages/task/src/node/task.ts:62