Beignet API reference
    Preparing search index...

    Interface JobDef<Name, Payload, Ctx>

    Job definition created by defineJob(...).

    interface JobDef<
        Name extends string = string,
        Payload extends StandardSchema = StandardSchema,
        Ctx = unknown,
    > {
        description?: string;
        hooks?: readonly (
            (
                args: JobHookArgs<JobDef<Name, Payload, Ctx>, Ctx>,
                next: () => Promise<void>,
            ) => MaybePromise<void>
        )[];
        kind: "job";
        name: Name;
        payload: Payload;
        retry?: JobRetryOptions;
        timeout?: JobDuration;
        unique?: JobUniqueConfig<Payload>;
        handle(
            args: JobHandleArgs<JobDef<Name, Payload, Ctx>, Ctx>,
        ): MaybePromise<void>;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index
    description? hooks? kind name payload retry? timeout? unique?
    handle
    description?: string

    Optional human-readable description for docs and tooling.

    hooks?: readonly (
        (
            args: JobHookArgs<JobDef<Name, Payload, Ctx>, Ctx>,
            next: () => Promise<void>,
        ) => MaybePromise<void>
    )[]

    Optional hooks that wrap each handler attempt for this job.

    kind: "job"

    Discriminator for job definitions.

    name: Name

    Stable job name used by dispatchers and provider adapters.

    payload: Payload

    Standard Schema payload validator.

    retry?: JobRetryOptions

    Retry metadata for durable job providers.

    timeout?: JobDuration

    Optional maximum execution time for each job handler attempt.

    unique?: JobUniqueConfig<Payload>

    Optional dispatch-time uniqueness guard.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods