Documentation
    Preparing search index...

    Type Alias ApiOptions

    Api connection options

    type ApiOptions = {
        bundleTime?: number;
        legacyDates?: boolean;
        manifest?: any;
        name?: string;
        offline?: number[];
        offlineBanner?: boolean | "top" | "bottom";
        origin?: string;
        pwaSettings?: {
            dismissExpiry?: number;
            loginLink?: boolean;
            timeout?: number;
        };
        saveSession?: boolean;
        serviceWorker?: string;
        socket?: false
        | string;
        webrtc?: {
            ice?: RTCIceServer[];
            password?: string;
            url: string;
            username?: string;
        };
    }
    Index

    Properties

    bundleTime? legacyDates? manifest? name? offline? offlineBanner? origin? pwaSettings? saveSession? serviceWorker? socket? webrtc?

    Properties

    bundleTime?: number

    Bundle requests together that happen in quick succession

    legacyDates?: boolean

    Use legacy dates by default

    manifest?: any

    PWA manifest overrides

    name?: string

    Name of application

    offline?: number[]

    List of slices to use offline

    offlineBanner?: boolean | "top" | "bottom"

    Display an offline banner

    origin?: string

    Website hostname

    pwaSettings?: { dismissExpiry?: number; loginLink?: boolean; timeout?: number }

    Progressive Web App settings

    Type declaration

    • OptionaldismissExpiry?: number

      Days until the dismissed prompt can show again. If set to 0 it will trigger every refresh. (Default is 7 days)

    • OptionalloginLink?: boolean

      Show PWA install link on login screen. Default is False

    • Optionaltimeout?: number

      How long to wait before showing the installation prompt (seconds). Default is 30 seconds

    saveSession?: boolean

    Save session token to localStorage to persist logins

    serviceWorker?: string

    Service worker URL

    socket?: false | string

    Disable sockets with false or override socket URL

    webrtc?: {
        ice?: RTCIceServer[];
        password?: string;
        url: string;
        username?: string;
    }

    WebRTC TURN server URL

    Type declaration

    • Optionalice?: RTCIceServer[]

      Additional ICE servers

    • Optionalpassword?: string

      TURN server password

    • url: string

      Auxilium WebRTC STUN/TURN server URL override

    • Optionalusername?: string

      TURN server username

    Settings

    Member Visibility

    On This Page

    Properties