Interface JobHookArgs<J, Ctx>

Arguments passed to job execution hooks.

interface JobHookArgs<J extends JobDef, Ctx> {
    attempt?: number;
    ctx: Ctx;
    job: J;
    maxAttempts?: number;
    payload: InferJobPayload<J>;
    signal: AbortSignal;
}

Type Parameters

J extends JobDef
Ctx

Hierarchy (View Summary)

JobHandleArgs<J, Ctx>
- JobHookArgs
  - JobExecutionLeaseUnavailableArgs

Index

Properties

attempt? ctx job maxAttempts? payload signal

Properties

`Optional`attempt

attempt?: number

One-based execution attempt when the runner can report it.

ctx

ctx: Ctx

Handler context.

job

job: J

Job definition being handled.

`Optional`maxAttempts

maxAttempts?: number

Maximum execution attempts when the runner can report it.

payload

payload: InferJobPayload<J>

Parsed job payload.

signal

signal: AbortSignal

Abort signal provided by the Beignet execution runner.