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
Type | Description | |
---|---|---|
manager | Manager | A reference to the |
taskId | Id | The |
taskRunId | Id | The |
reason | TaskRunReason | The reason the task run failed. |
message | string | A string message indicating the reason for the failure (in the case of an error being thrown). |
returns | void | 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