Beignet API reference
    Preparing search index...

    Interface InlineNotificationsProviderOptions

    Options for the inline notifications provider.

    interface InlineNotificationsProviderOptions {
        failureMode?: "throw" | "report";
        name?: string;
        onError?: (
            error: unknown,
            args: NotificationChannelHandleArgs<StandardSchema, unknown>,
        ) => MaybePromise<NotificationChannelResult | undefined>;
        preferences?: NotificationPreferencesPort<unknown>;
    }

    Hierarchy

    Index
    failureMode? name? onError? preferences?
    failureMode?: "throw" | "report"

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

    name?: string

    Provider name. Defaults to "inline-notifications".

    onError?: (
        error: unknown,
        args: NotificationChannelHandleArgs<StandardSchema, unknown>,
    ) => 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<unknown>

    Optional app-owned notification preference evaluator.

    Settings
    Member Visibility

    On This Page
    Properties