W3Booster SDK 2.0.0
    Preparing search index...

    Interface OverlayCompositionOptions

    interface OverlayCompositionOptions {
        backend?: "auto" | "local" | "cloud";
        backendUrl?: string;
        browserSource?: BrowserSourceCredentials;
        onError?: (error: unknown) => void | Promise<void>;
        signal?: AbortSignal;
        surface?: OverlaySurface;
        tokenProvider?: () => string | Promise<string | null> | null;
    }
    Index
    backend? backendUrl? browserSource? onError? signal? surface? tokenProvider?
    backend?: "auto" | "local" | "cloud"

    Defaults to cloud. Platform-provided backend=local|cloud takes precedence.

    backendUrl?: string

    Explicit platform API origin. Prefer backend for standard local/cloud selection.

    browserSource?: BrowserSourceCredentials

    Stable credentials from the user's W3Booster browser-source URL.

    onError?: (error: unknown) => void | Promise<void>
    signal?: AbortSignal

    Cancels one-shot loading and owns the returned watcher lifetime.

    surface?: OverlaySurface
    tokenProvider?: () => string | Promise<string | null> | null

    Supplies the current compositor credential for each authorization attempt.

    Settings
    Member Visibility

    On This Page
    Properties