Beignet API reference
    Preparing search index...

    Interface DefineNotificationDeliveryJobOptions<Name, Ctx>

    Options for the first-party notification delivery job.

    interface DefineNotificationDeliveryJobOptions<Name extends string, Ctx> {
        hooks?: readonly JobHook<
            JobDef<Name, NotificationDeliveryPayloadSchema, Ctx>,
            Ctx,
        >[];
        name?: Name;
        preferences?: NotificationPreferencesPort<Ctx>;
        registry: NotificationRegistry<Ctx>;
        retry?: JobRetryOptions;
        timeout?: JobDuration;
    }

    Type Parameters

    • Name extends string
    • Ctx
    Index
    hooks? name? preferences? registry retry? timeout?
    hooks?: readonly JobHook<
        JobDef<Name, NotificationDeliveryPayloadSchema, Ctx>,
        Ctx,
    >[]

    Optional execution hooks applied to each delivery attempt.

    name?: Name

    Stable job name. Defaults to "notifications.deliver".

    preferences?: NotificationPreferencesPort<Ctx>

    Optional app-owned preferences evaluated when the job runs.

    registry: NotificationRegistry<Ctx>

    Notification definitions available to the worker.

    retry?: JobRetryOptions

    Retry policy. Defaults to exponential backoff with three attempts.

    timeout?: JobDuration

    Optional maximum duration for each channel delivery attempt.

    Settings
    Member Visibility

    On This Page
    Properties