Interface: TaskExecutorEventsDict
events.TaskExecutorEventsDict
This interface describes events emitted by TaskExecutor through TaskExecutor.events object.
Table of contents
Properties
- start
- ready
- beforeEnd
- criticalError
- end
- taskQueued
- taskStarted
- taskRetried
- taskCompleted
- taskFailed
- golemEvents
Properties
start
• start: (timestamp: number) => void
Type declaration
â–¸ (timestamp): void
Fires when task executor is created, before initialization services.
Parameters
| Name | Type |
|---|---|
timestamp | number |
Returns
void
Defined in
ready
• ready: (timestamp: number) => void
Type declaration
â–¸ (timestamp): void
Fires when task executor is initialized and ready to be used.
Parameters
| Name | Type |
|---|---|
timestamp | number |
Returns
void
Defined in
beforeEnd
• beforeEnd: (timestamp: number) => void
Type declaration
â–¸ (timestamp): void
Fires when task executor is about to shut down, immediately after TaskExecutor.shutdown() is called.
Parameters
| Name | Type |
|---|---|
timestamp | number |
Returns
void
Defined in
criticalError
• criticalError: (err: Error) => void
Type declaration
â–¸ (err): void
Fires when task executor encountered an unrecoverable error and is about to shut down.
Parameters
| Name | Type |
|---|---|
err | Error |
Returns
void
Defined in
end
• end: (timestamp: number) => void
Type declaration
â–¸ (timestamp): void
Fires when task executor is completely terminated.
Parameters
| Name | Type |
|---|---|
timestamp | number |
Returns
void
Defined in
taskQueued
• taskQueued: (task: TaskDetails) => void
Type declaration
â–¸ (task): void
Fires when a task is placed in the internal queue via TaskExecutor.run
Parameters
| Name | Type |
|---|---|
task | TaskDetails |
Returns
void
Defined in
taskStarted
• taskStarted: (task: TaskDetails) => void
Type declaration
â–¸ (task): void
Fires when the task gets picked up from the internal queue and is getting executed
Parameters
| Name | Type |
|---|---|
task | TaskDetails |
Returns
void
Defined in
taskRetried
• taskRetried: (task: TaskDetails) => void
Type declaration
â–¸ (task): void
Fires when the task had to be re-tried due to an error check - error for details of the issue
Parameters
| Name | Type |
|---|---|
task | TaskDetails |
Returns
void
Defined in
taskCompleted
• taskCompleted: (task: TaskDetails) => void
Type declaration
â–¸ (task): void
Fires when a task is successfully completed
Parameters
| Name | Type |
|---|---|
task | TaskDetails |
Returns
void
Defined in
taskFailed
• taskFailed: (task: TaskDetails) => void
Type declaration
â–¸ (task): void
Fires when a task has failed and won't be re-tried any longer
Parameters
| Name | Type |
|---|---|
task | TaskDetails |
Returns
void
Defined in
golemEvents
• golemEvents: (event: BaseEvent<unknown>) => void
Type declaration
â–¸ (event): void
Exposes internal @golem-sdk/golem-js events
Parameters
| Name | Type |
|---|---|
event | BaseEvent<unknown> |
Returns
void
Deprecated
This options is deprecated and will be removed. Alternative ways to reach these events will be provided.