Class CustomTask

Represents a Task launched as a fake process by CustomTaskRunner.

Hierarchy (view full)

Task
- CustomTask

Index

Constructors

Properties

exitEmitter logger options outputEmitter taskId taskManager toDispose

Accessors

context id label onExit onOutput process

Methods

callbackTaskComplete dispose fireOutputLine fireTaskExited getRuntimeInfo kill

Constructors

constructor

new CustomTask(taskManager, logger, options): CustomTask
Parameters
- taskManager: TaskManager
- logger: ILogger
- options: TaskCustomOptions
Returns CustomTask
Overrides Task.constructor
- Defined in packages/task/src/node/custom/custom-task.ts:36

Properties

`Readonly` exitEmitter

exitEmitter: Emitter<TaskExitedEvent>

`Protected` `Readonly` logger

logger: ILogger

`Protected` `Readonly` options

options: TaskCustomOptions

`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
Inherited from Task.context
- Defined in packages/task/src/node/task.ts:92

id

get id(): number
Returns number
Inherited from Task.id
- Defined in packages/task/src/node/task.ts:88

label

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

onExit

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

onOutput

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

process

get process(): Process
Returns Process
- Defined in packages/task/src/node/custom/custom-task.ts:70

Methods

callbackTaskComplete

callbackTaskComplete(exitCode): MaybePromise<void>
Parameters
- exitCode: undefined | number
Returns MaybePromise<void>
- Defined in packages/task/src/node/custom/custom-task.ts:59

dispose

dispose(): void
Returns void
Inherited from Task.dispose
- Defined in packages/task/src/node/task.ts:100

`Protected` fireOutputLine

fireOutputLine(event): void
Parameters
- event: TaskOutputEvent
Returns void
Inherited from Task.fireOutputLine
- 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
Inherited from Task.fireTaskExited
- Defined in packages/task/src/node/task.ts:73

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.
Overrides Task.getRuntimeInfo
- Defined in packages/task/src/node/custom/custom-task.ts:49

kill

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

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