Class ProcessTask

Represents a Task launched as a process by ProcessTaskRunner.

Hierarchy (View Summary)

Task
- ProcessTask

Index

Constructors

Properties

command exitEmitter logger options outputEmitter taskId taskManager toDispose

Accessors

context id label onExit onOutput process processType

Methods

dispose fireOutputLine fireTaskExited getRuntimeInfo getTaskExitedEvent kill

Constructors

constructor

new ProcessTask(
    taskManager: TaskManager,
    logger: ILogger,
    options: TaskProcessOptions,
): ProcessTask
Parameters
- taskManager: TaskManager
- logger: ILogger
- options: TaskProcessOptions
Returns ProcessTask
Overrides Task.constructor
- Defined in packages/task/src/node/process/process-task.ts:60

Properties

`Protected`command

command: undefined | string

`Readonly`exitEmitter

exitEmitter: Emitter<TaskExitedEvent>

`Protected` `Readonly`logger

logger: ILogger

`Protected` `Readonly`options

options: TaskProcessOptions

`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/process/process-task.ts:137

processType

get processType(): ProcessType
Returns ProcessType
- Defined in packages/task/src/node/process/process-task.ts:141

Methods

dispose

dispose(): void
Dispose this object.

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

`Protected`fireOutputLine

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

getRuntimeInfo

getRuntimeInfo(): ProcessTaskInfo
Retrieves the runtime information about this task. The runtime information computation may happen asynchronous.

Returns ProcessTaskInfo
(a promise of) the runtime information as TaskInfo.
Overrides Task.getRuntimeInfo
- Defined in packages/task/src/node/process/process-task.ts:126

`Protected`getTaskExitedEvent

getTaskExitedEvent(evt: IProcessExitEvent): Promise<TaskExitedEvent>
Parameters
- evt: IProcessExitEvent
Returns Promise<TaskExitedEvent>
- Defined in packages/task/src/node/process/process-task.ts:114

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/process/process-task.ts:100