Beignet API reference
    Preparing search index...

    Interface InlineNotificationDispatcherOptions<Ctx>

    Options for the inline notification dispatcher.

    interface InlineNotificationDispatcherOptions<Ctx> {
        ctx?: Ctx | (() => MaybePromise<Ctx>);
        failureMode?: "throw" | "report";
        instrumentation?: ProviderInstrumentationTarget;
        onError?: (
            error: unknown,
            args: NotificationChannelHandleArgs<StandardSchema, Ctx>,
        ) => MaybePromise<NotificationChannelResult | undefined>;
        preferences?: NotificationPreferencesPort<Ctx>;
    }

    Type Parameters

    • Ctx
    Index
    ctx? failureMode? instrumentation? onError? preferences?
    ctx?: Ctx | (() => MaybePromise<Ctx>)

    Static notification context or factory evaluated for each send.

    failureMode?: "throw" | "report"

    How completed channel failures are surfaced. Defaults to "report". "throw" still runs every selected channel before rejecting.

    instrumentation?: ProviderInstrumentationTarget

    Optional devtools/provider instrumentation target.

    onError?: (
        error: unknown,
        args: NotificationChannelHandleArgs<StandardSchema, Ctx>,
    ) => MaybePromise<NotificationChannelResult | undefined>

    Called when a channel handler or preference check fails. A returned result replaces the default failed result. Observer failures are ignored so the remaining channels still run.

    preferences?: NotificationPreferencesPort<Ctx>

    Optional app-owned notification preference evaluator.

    Settings
    Member Visibility

    On This Page
    Properties