TaskRunInfo
The TaskRunInfo
type represents information about a scheduled or running task run.
{
manager: Manager;
taskId: Id;
taskRunId: Id;
arg: string | undefined;
retry: number;
running: boolean;
nextTimestamp: TimestampMs;
}
Type | Description | |
---|---|---|
manager | Manager | A reference to the |
taskId | Id | The |
taskRunId | Id | The |
arg | string | undefined | The string argument that was provided when the task was scheduled to run, or |
retry | number | The number of times that this task run has been retried. |
running | boolean | Whether the task is currently running ( |
nextTimestamp | TimestampMs | The timestamp of when the task run is scheduled to start (if not yet running), or when it is scheduled to be aborted (if running). |
Its properties include the task Id
, any argument provided, whether it is currently running, and so on. This is passed to a task when it runs, so can be used for understanding the context of the run (such as whether it is a retry, and so on).
Since
v1.0.0