@qtsurfer/sdk
    Preparing search index...

    Interface QTSurferOptions

    Configuration for QTSurfer.

    interface QTSurferOptions {
        baseUrl: string;
        fetch?: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        liveUrl?: string;
        token?: string;
    }
    Index
    baseUrl fetch? liveUrl? token?
    baseUrl: string

    Base URL of the QTSurfer API, e.g. https://api.qtsurfer.net/v1.

    fetch?: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }

    Inject a custom fetch (Node 20+, browser, or test mock).

    Type Declaration

      • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | Request | URL, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: string | Request | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

    liveUrl?: string

    Override the Centrifugo endpoint used by QTSurfer.connectLive.

    token?: string

    Pre-obtained bearer token. When omitted, requests go out unauthenticated. Use the authenticate() helper instead of this constructor if you want the SDK to exchange an apikey for a JWT and refresh it on 401 for you.

    Settings
    Member Visibility

    On This Page
    Properties