TinyTick logoTinyTick

TaskRunRunningListener

The TaskRunRunningListener type describes a function that is used to listen to changes to a specific task run in the Manager.

(
  manager: Manager,
  taskId: Id,
  taskRunId: Id,
  running: boolean | undefined,
  reason: TaskRunReason,
): void
TypeDescription
managerManager

A reference to the Manager that changed.

taskIdId

The Id of the task that changed.

taskRunIdId

The Id of the task run that changed.

runningboolean | undefined

Whether the task run is now running (true), scheduled (false), or deleted (undefined).

reasonTaskRunReason

The reason the task run changed.

returnsvoid

This has no return value.

A TaskRunRunningListener is provided when using the addTaskRunRunningListener method. See that method for specific examples.

When called, a TaskRunRunningListener is given a reference to the Manager, the Id of the task, the Id of the task run that changed, the way in which it changed, and the reason for that change.

Since

v1.2.0