For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10

Type Alias: JobErrorRequest

type JobErrorRequest = object;

Properties​

errorCode​

errorCode: string;

The error code that will be matched with an error catch event.

errorMessage?​

optional errorMessage?: string | null;

An error message that provides additional context.

jobLeaseToken?​

optional jobLeaseToken?: JobLeaseToken | null;

The token identifying a leased job's activation, obtained from ActivatedJobResult.jobLeaseToken. For a leased job, the matching token must be supplied to prove the command comes from the worker that holds the current lease; a command with no token is rejected. A command carrying a stale token is likewise rejected, fencing the job against a superseded activation (for example, after the job timed out or failed and was re-activated by another worker). A job that was activated without a lease requires no token.

variables?​

optional variables?:
  | {
[key: string]: unknown;
}
  | null;

JSON object that will instantiate the variables at the local scope of the error catch event that catches the thrown error.