JS Task API Reference

Interface: TaskExecutorEventsDict

events.TaskExecutorEventsDict

This interface describes events emitted by TaskExecutor through TaskExecutor.events object.

Table of contents

Properties

Properties

start

start: () => void

Type declaration

▸ (): void

Fires when task executor is created, before initialization services.

Returns

void

Defined in

src/events.ts:11


ready

ready: () => void

Type declaration

▸ (): void

Fires when task executor is initialized and ready to be used.

Returns

void

Defined in

src/events.ts:16


beforeEnd

beforeEnd: () => void

Type declaration

▸ (): void

Fires when task executor is about to shut down, immediately after TaskExecutor.shutdown() is called.

Returns

void

Defined in

src/events.ts:21


end

end: () => void

Type declaration

▸ (): void

Fires when task executor is completely terminated.

Returns

void

Defined in

src/events.ts:26


taskQueued

taskQueued: (task: TaskDetails) => void

Type declaration

▸ (task): void

Parameters
NameType
taskTaskDetails
Returns

void

Defined in

src/events.ts:28


taskStarted

taskStarted: (task: TaskDetails) => void

Type declaration

▸ (task): void

Parameters
NameType
taskTaskDetails
Returns

void

Defined in

src/events.ts:29


taskRetried

taskRetried: (task: TaskDetails) => void

Type declaration

▸ (task): void

Parameters
NameType
taskTaskDetails
Returns

void

Defined in

src/events.ts:30


taskCompleted

taskCompleted: (task: TaskDetails) => void

Type declaration

▸ (task): void

Parameters
NameType
taskTaskDetails
Returns

void

Defined in

src/events.ts:31


taskFailed

taskFailed: (task: TaskDetails) => void

Type declaration

▸ (task): void

Parameters
NameType
taskTaskDetails
Returns

void

Defined in

src/events.ts:32


golemEvents

golemEvents: (event: BaseEvent<unknown>) => void

Type declaration

▸ (event): void

Parameters
NameType
eventBaseEvent<unknown>
Returns

void

Defined in

src/events.ts:34

Was this helpful?