Class CustomTask

Represents a Task launched as a fake process by CustomTaskRunner.

Hierarchy

Task
- CustomTask

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CustomTask(taskManager: TaskManager, logger: ILogger, options: TaskCustomOptions): CustomTask

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

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

Inherited from Task.context
- Defined in packages/task/src/node/task.ts:92
Returns undefined | string

id

get id(): number

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

label

get label(): string

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

onExit

get onExit(): Event<TaskExitedEvent>

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

onOutput

get onOutput(): Event<TaskOutputEvent>

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

process

get process(): Process

- Defined in packages/task/src/node/custom/custom-task.ts:70
Returns Process

Methods

callbackTaskComplete

callbackTaskComplete(exitCode: undefined | number): MaybePromise<void>

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

dispose

dispose(): void

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

Protected fireOutputLine

fireOutputLine(event: TaskOutputEvent): void

Inherited from Task.fireOutputLine
- Defined in packages/task/src/node/task.ts:77
Parameters
- event: TaskOutputEvent
Returns void

Protected fireTaskExited

fireTaskExited(event: TaskExitedEvent): void

Inherited from Task.fireTaskExited
- Defined in packages/task/src/node/task.ts:73
Has to be called when a task has concluded its execution.

Parameters
- event: TaskExitedEvent
Returns void

getRuntimeInfo

getRuntimeInfo(): MaybePromise<TaskInfo>

Overrides Task.getRuntimeInfo
- Defined in packages/task/src/node/custom/custom-task.ts:49
Retrieves the runtime information about this task. The runtime information computation may happen asynchronous.

Returns MaybePromise<TaskInfo>

kill

kill(): Promise<void>

Overrides Task.kill
- Defined in packages/task/src/node/custom/custom-task.ts:45
Terminate this task.

Returns Promise<void>