Class TasksExchange

Hierarchy

AbstractExchange<TasksRequest, TasksResponse>
- TasksExchange

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TasksExchange(): TasksExchange

Overrides AbstractExchange.constructor
- Defined in src/adapters/exchange/tasks/TasksExchange.ts:25
Returns TasksExchange

Properties

logger

logger: ILoggerApi = ...

Readonly reqCls

reqCls: ClassType<TasksRequest>

Readonly resCls

resCls: ClassType<TasksResponse>

runnerRegistry

runnerRegistry: TaskRunnerRegistry

Methods

create

create(options?: IMessageOptions): Message<TasksRequest, TasksResponse>

Inherited from AbstractExchange.create
- Defined in src/libs/messaging/AbstractExchange.ts:59
Parameters
- options: IMessageOptions = {}
Returns Message<TasksRequest, TasksResponse>

getLogFile

getLogFile(runnerId: string, opts?: IFileSelectOptions): Promise<any[]>

- Defined in src/adapters/exchange/tasks/TasksExchange.ts:53
Get log file content

Parameters
- runnerId: string
- opts: IFileSelectOptions = {}
Returns Promise<any[]>

getLogFilePath

getLogFilePath(runnerId: string, opts?: IMessageOptions & { relative?: boolean }): Promise<any[]>

- Defined in src/adapters/exchange/tasks/TasksExchange.ts:38
Get log file path to fetch file content over FileSystemHandle

Parameters
- runnerId: string
- opts: IMessageOptions & { relative?: boolean } = {}
Returns Promise<any[]>

getReqClass

getReqClass(): ClassType<TasksRequest>

Inherited from AbstractExchange.getReqClass
- Defined in src/libs/messaging/AbstractExchange.ts:49
Returns ClassType<TasksRequest>

getResClass

getResClass(): ClassType<TasksResponse>

Inherited from AbstractExchange.getResClass
- Defined in src/libs/messaging/AbstractExchange.ts:54
Returns ClassType<TasksResponse>

getResponse

getResponse(request: TasksRequest): Promise<TasksResponse>

Inherited from AbstractExchange.getResponse
- Defined in src/libs/messaging/AbstractExchange.ts:64
Parameters
- request: TasksRequest
Returns Promise<TasksResponse>

getRunners

getRunners(opts?: IMessageOptions): Promise<any[]>

- Defined in src/adapters/exchange/tasks/TasksExchange.ts:81
Get current running runners

Parameters
- opts: IMessageOptions = {}
Returns Promise<any[]>

getRunningTasks

getRunningTasks(opts?: IMessageOptions): Promise<any[]>

- Defined in src/adapters/exchange/tasks/TasksExchange.ts:93
Get current running runners

Parameters
- opts: IMessageOptions = {}
Returns Promise<any[]>

getStatus

getStatus(runnerId: string, opts?: IMessageOptions): Promise<any[]>

- Defined in src/adapters/exchange/tasks/TasksExchange.ts:68
Get status information of a running task

Parameters
- runnerId: string
- opts: IMessageOptions = {}
Returns Promise<any[]>

getSystem

getSystem(): System

Inherited from AbstractExchange.getSystem
- Defined in src/libs/messaging/AbstractExchange.ts:44
Returns System

handleRequest

handleRequest(request: TasksRequest, response: TasksResponse): Promise<void>

Overrides AbstractExchange.handleRequest
- Defined in src/adapters/exchange/tasks/TasksExchange.ts:132
Parameters
- request: TasksRequest
- response: TasksResponse
Returns Promise<void>

handleResponse

handleResponse(responses: TasksResponse): string | ITaskRunnerResult[] | ITaskRunnerStatus[] | TaskLog

Overrides AbstractExchange.handleResponse
- Defined in src/adapters/exchange/tasks/TasksExchange.ts:204
Parameters
- responses: TasksResponse
Returns string | ITaskRunnerResult[] | ITaskRunnerStatus[] | TaskLog

isActive

isActive(): boolean

Inherited from AbstractExchange.isActive
- Defined in src/libs/messaging/AbstractExchange.ts:39
Give possiblity to mark this exchange as disabled

Returns boolean

onRequest

onRequest(request: TasksRequest): Promise<any>

Inherited from AbstractExchange.onRequest
- Defined in src/libs/messaging/AbstractExchange.ts:78
Parameters
- request: TasksRequest
Returns Promise<any>

prepare

prepare(opts?: any): void

Inherited from AbstractExchange.prepare
- Defined in src/libs/messaging/AbstractExchange.ts:32
Parameters
- opts: any = {}
Returns void

Generated using TypeDoc