Beignet API reference
    Preparing search index...

    Interface NotificationDeliveryJob<Name, Ctx>

    Job definition used by queued notification dispatchers and workers.

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

    Type Parameters

    • Name extends string = string
    • Ctx = unknown

    Hierarchy (View Summary)

    • JobDef<Name, NotificationDeliveryPayloadSchema, Ctx>
      • NotificationDeliveryJob
    Index
    description? hooks? kind name payload registry retry? timeout? unique?
    handle
    description?: string

    Optional human-readable description for docs and tooling.

    hooks?: readonly (
        (
            args: JobHookArgs<
                JobDef<Name, NotificationDeliveryPayloadSchema, 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: NotificationDeliveryPayloadSchema

    Standard Schema payload validator.

    registry: NotificationRegistry<Ctx>

    Registry used by both enqueue-time checks and worker delivery.

    retry?: JobRetryOptions

    Retry metadata for durable job providers.

    timeout?: JobDuration

    Optional maximum execution time for each job handler attempt.

    unique?: JobUniqueConfig<NotificationDeliveryPayloadSchema>

    Optional dispatch-time uniqueness guard.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods