Interface DefineJobOptions<Name, Payload, Ctx>

Options for declaring a typed job.

interface DefineJobOptions<
    Name extends string,
    Payload extends StandardSchema,
    Ctx,
> {
    description?: string;
    payload: Payload;
    retry?: JobRetryOptions;
    handle(
        args: JobHandleArgs<JobDef<Name, Payload, Ctx>, Ctx>,
    ): MaybePromise<void>;
}

Type Parameters

Name extends string
Payload extends StandardSchema
Ctx

Index

Properties

description? payload retry?

Methods

Properties

`Optional`description

description?: string

Optional human-readable description for docs and tooling.

payload

payload: Payload

Standard Schema payload validator.

`Optional`retry

retry?: JobRetryOptions

Retry metadata for durable job providers.

Methods

handle

handle(args: JobHandleArgs<JobDef<Name, Payload, Ctx>, Ctx>): MaybePromise<void>
Handle a parsed job payload.
Parameters
- args: JobHandleArgs<JobDef<Name, Payload, Ctx>, Ctx>
Returns MaybePromise<void>
- Defined in packages/core/src/jobs/index.ts:115