Skip to main content

Listener

Nadle / Listener

Interface: Listener

Defined in: packages/nadle/src/core/interfaces/listener.ts:7

Listener interface for handling various task and execution lifecycle events.

Properties​

onExecutionFailed?​

readonly optional onExecutionFailed?: (error) => Awaitable<void>

Defined in: packages/nadle/src/core/interfaces/listener.ts:22

Called when execution fails.

Parameters​

error​

unknown

The error that caused the failure.

Returns​

Awaitable<void>

onExecutionFinish?​

readonly optional onExecutionFinish?: () => Awaitable<void>

Defined in: packages/nadle/src/core/interfaces/listener.ts:16

Called when execution finishes successfully.

Returns​

Awaitable<void>

onExecutionStart?​

readonly optional onExecutionStart?: () => Awaitable<void>

Defined in: packages/nadle/src/core/interfaces/listener.ts:11

Called when execution starts.

Returns​

Awaitable<void>

onInitialize?​

readonly optional onInitialize?: () => Awaitable<Listener>

Defined in: packages/nadle/src/core/interfaces/listener.ts:77

Optional initialization method for the listener.

Returns​

Awaitable<Listener>

The initialized listener instance.

onTaskCanceled?​

readonly optional onTaskCanceled?: (task) => Awaitable<void>

Defined in: packages/nadle/src/core/interfaces/listener.ts:40

Called when a task is canceled.

Parameters​

task​

RegisteredTask

The canceled task.

Returns​

Awaitable<void>

onTaskFailed?​

readonly optional onTaskFailed?: (task) => Awaitable<void>

Defined in: packages/nadle/src/core/interfaces/listener.ts:34

Called when a task fails.

Parameters​

task​

RegisteredTask

The failed task.

Returns​

Awaitable<void>

onTaskFinish?​

readonly optional onTaskFinish?: (task) => Awaitable<void>

Defined in: packages/nadle/src/core/interfaces/listener.ts:28

Called when a task finishes successfully.

Parameters​

task​

RegisteredTask

The finished task.

Returns​

Awaitable<void>

onTaskRestoreFromCache?​

readonly optional onTaskRestoreFromCache?: (task) => Awaitable<void>

Defined in: packages/nadle/src/core/interfaces/listener.ts:64

Called when a task is restored from cache.

Parameters​

task​

RegisteredTask

The restored task.

Returns​

Awaitable<void>

onTaskSkipped?​

readonly optional onTaskSkipped?: (task) => Awaitable<void>

Defined in: packages/nadle/src/core/interfaces/listener.ts:52

Called when a task is skipped because its onlyIf predicate resolved falsey.

Parameters​

task​

RegisteredTask

The skipped task.

Returns​

Awaitable<void>

onTasksScheduled?​

readonly optional onTasksScheduled?: (tasks) => Awaitable<void>

Defined in: packages/nadle/src/core/interfaces/listener.ts:58

Called when tasks are scheduled for execution.

Parameters​

tasks​

RegisteredTask[]

The scheduled tasks.

Returns​

Awaitable<void>

onTaskStart?​

readonly optional onTaskStart?: (task, threadId) => Awaitable<void>

Defined in: packages/nadle/src/core/interfaces/listener.ts:71

Called when a task starts execution.

Parameters​

task​

RegisteredTask

The started task.

threadId​

number

The thread ID where the task is running.

Returns​

Awaitable<void>

onTaskUpToDate?​

readonly optional onTaskUpToDate?: (task) => Awaitable<void>

Defined in: packages/nadle/src/core/interfaces/listener.ts:46

Called when a task is up to date and does not need to run.

Parameters​

task​

RegisteredTask

The up-to-date task.

Returns​

Awaitable<void>