Interface JobDef<Name, Payload, Ctx>

Job definition created by defineJob(...).

interface JobDef<
    Name extends string = string,
    Payload extends StandardSchema = StandardSchema,
    Ctx = unknown,
> {
    description?: string;
    kind: "job";
    name: Name;
    payload: Payload;
    retry?: JobRetryOptions;
    handle(
        args: JobHandleArgs<JobDef<Name, Payload, Ctx>, Ctx>,
    ): MaybePromise<void>;
}

Type Parameters

Name extends string = string
Payload extends StandardSchema = StandardSchema
Ctx = unknown

Index

Properties

description? kind name payload retry?

Methods

Properties

`Optional` `Readonly`description

description?: string

Optional human-readable description for docs and tooling.

`Readonly`kind

kind: "job"

Discriminator for job definitions.

`Readonly`name

name: Name

Stable job name used by dispatchers and provider adapters.

`Readonly`payload

payload: Payload

Standard Schema payload validator.

`Optional` `Readonly`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:50