W3Booster SDK 2.0.0
    Preparing search index...

    Interface TestingConnectOptions<TSettings, TOverlayExtensions>

    interface TestingConnectOptions<
        TSettings extends object = JsonObject,
        TOverlayExtensions extends object = object,
    > {
        applicationRevision?: string;
        autoResize?: boolean;
        backend?: "auto" | "local" | "cloud";
        backendUrl?: string;
        clientId: string;
        demo?:
            | boolean
            | {
                interval?: number;
                settings?: JsonCompatible<TSettings>;
                state?: MatchState<TSettings, TOverlayExtensions>;
                surface?: AppSurface;
            };
        localRecorder?: boolean;
        reconnect?: boolean
        | ReconnectOptions;
        retry?: boolean | RetryOptions;
        scopes?: "configured" | readonly Scope[];
        signal?: AbortSignal;
        tokenProvider?: () => string | Promise<string | null> | null;
        transport: Transport;
    }

    Type Parameters

    • TSettings extends object = JsonObject
    • TOverlayExtensions extends object = object

    Hierarchy (View Summary)

    Index
    applicationRevision? autoResize? backend? backendUrl? clientId demo? localRecorder? reconnect? retry? scopes? signal? tokenProvider? transport
    applicationRevision?: string

    Generated application-definition revision. defineApplication() supplies this automatically.

    autoResize?: boolean

    Automatically report embedded application height to W3Booster. Defaults to true.

    backend?: "auto" | "local" | "cloud"

    Defaults to cloud. A platform-provided backend=local|cloud launch parameter takes precedence; applications do not parse it themselves.

    backendUrl?: string

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

    clientId: string
    demo?:
        | boolean
        | {
            interval?: number;
            settings?: JsonCompatible<TSettings>;
            state?: MatchState<TSettings, TOverlayExtensions>;
            surface?: AppSurface;
        }

    Type Declaration

    localRecorder?: boolean

    Prefer the recorder's low-latency observer/replay feed when the platform exposes one. Defaults to true.

    reconnect?: boolean | ReconnectOptions

    Retry transient failures after an established broker socket closes. Defaults to unlimited reconnects.

    retry?: boolean | RetryOptions

    Retry transient initial connection failures. Unlimited policies require signal; an object configures the backoff.

    scopes?: "configured" | readonly Scope[]

    Uses the scopes configured for the app by default. Pass an array only to request a smaller subset.

    signal?: AbortSignal

    Owns the client lifetime: aborting cancels connection attempts and disconnects an established client.

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

    Supplies the current bearer credential for each broker ticket request, including reconnects.

    transport: Transport

    Settings
    Member Visibility

    On This Page
    Properties