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 full)

Task
- CustomTask
- ProcessTask

Implements

Disposable
ManagedTask

Index

Constructors

constructor

new Task(taskManager, logger, options): 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
Returns void
Implementation of Disposable.dispose
- Defined in packages/task/src/node/task.ts:100

`Protected` fireOutputLine

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

`Protected` fireTaskExited

fireTaskExited(event): 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

Class TaskAbstract

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Task

Properties

Readonly exitEmitter

Protected Readonly logger

Protected Readonly options

Readonly outputEmitter

Protected taskId

Protected Readonly taskManager

Protected Readonly toDispose

Accessors

context

Returns undefined | string

id

Returns number

label

Returns string

onExit

Returns Event<TaskExitedEvent>

onOutput

Returns Event<TaskOutputEvent>

Methods

dispose

Returns void

Protected fireOutputLine

Parameters

Returns void

Protected fireTaskExited

Parameters

Returns void

Abstract getRuntimeInfo

Returns MaybePromise<TaskInfo>

Abstract kill

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Class Task`Abstract`

`Readonly` exitEmitter

`Protected` `Readonly` logger

`Protected` `Readonly` options

`Readonly` outputEmitter

`Protected` taskId

`Protected` `Readonly` taskManager

`Protected` `Readonly` toDispose

`Protected` fireOutputLine

`Protected` fireTaskExited

`Abstract` getRuntimeInfo

`Abstract` kill