Interface TaskServer

Hierarchy

JsonRpcServer<TaskClient>
- TaskServer

Index

Methods

Methods

customExecutionComplete

customExecutionComplete(id: number, exitCode: undefined | number): Promise<void>

- Defined in packages/task/src/common/task-protocol.ts:225
plugin callback task complete

Parameters
- id: number
- exitCode: undefined | number
Returns Promise<void>

disconnectClient

disconnectClient(client: TaskClient): void

- Defined in packages/task/src/common/task-protocol.ts:219
removes the client that has disconnected

Parameters
- client: TaskClient
Returns void

getRegisteredTaskTypes

getRegisteredTaskTypes(): Promise<string[]>

- Defined in packages/task/src/common/task-protocol.ts:222
Returns the list of default and registered task runners

Returns Promise<string[]>

getTasks

getTasks(ctx?: string): Promise<TaskInfo[]>

- Defined in packages/task/src/common/task-protocol.ts:216
Returns a list of currently running tasks. If a context is provided, only the tasks started in that context will be provided. Using an undefined context matches all tasks, no matter the creation context.

Parameters
- Optional ctx: string
Returns Promise<TaskInfo[]>

kill

kill(taskId: number): Promise<void>

- Defined in packages/task/src/common/task-protocol.ts:210
Kill a task, by id.

Parameters
- taskId: number
Returns Promise<void>

run

run(task: TaskConfiguration, ctx?: string, option?: RunTaskOption): Promise<TaskInfo>

- Defined in packages/task/src/common/task-protocol.ts:208
Run a task. Optionally pass a context.

Parameters
- task: TaskConfiguration
- Optional ctx: string
- Optional option: RunTaskOption
Returns Promise<TaskInfo>