Beignet API reference
    Preparing search index...

    Interface DefineJobOptions<Name, Payload, Ctx>

    Options for declaring a typed job.

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

    Type Parameters

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

    Optional human-readable description for docs and tooling.

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

    Optional hooks that wrap each handler attempt for this job.

    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