TinyTick logoTinyTick

TaskRunFailedListener

The TaskRunFailedListener type describes a function that is used to listen to a failing task run, whether because of timeout, error, or deletion.

(
  manager: Manager,
  taskId: Id,
  taskRunId: Id,
  reason: TaskRunReason,
  message: string,
): 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.

reasonTaskRunReason

The reason the task run failed.

messagestring

A string message indicating the reason for the failure (in the case of an error being thrown).

returnsvoid

This has no return value.

A TaskRunFailedListener is provided when using the addTaskRunFailedListener method. See that method for specific examples.

When called, a TaskRunFailedListener is given a reference to the Manager, the Id of the task, the Id of the task run that changed, the reason it failed, and a string message (in the case of an error being thrown).

Since

v1.2.0