Beignet API reference
    Preparing search index...

    Interface JobHandleArgs<J, Ctx>

    Arguments passed to a job handler.

    interface JobHandleArgs<J extends JobDef, Ctx> {
        ctx: Ctx;
        job: J;
        payload: InferJobPayload<J>;
        signal?: AbortSignal;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index
    ctx: Ctx

    Handler context.

    job: J

    Job definition being handled.

    payload: InferJobPayload<J>

    Parsed job payload.

    signal?: AbortSignal

    Abort signal that fires when the job's declared timeout expires.

    Beignet dispatchers and worker helpers provide this signal. It is optional in the type so direct handler tests can stay lightweight.

    JavaScript cannot forcibly stop arbitrary async work, so handlers that call cancellable APIs should pass this signal through.