BIM.works SDKs - v3.0.0-b.115
    Preparing search index...

    Interface BimWorksClientFactorySettings

    interface BimWorksClientFactorySettings {
        fetchOptionsInterceptor?: unknown;
        lintingFix?: void;
        networkUsage?: NetworkUsageSettings;
        stats?: GroupStat;
        upload?: { useHttp?: boolean };
        websocket?: {
            compressed?: boolean;
            initialReconnectTimeout?: number;
            maxReconnects?: number;
            reconnectIncreaseFactor?: number;
        };
        xmlHttpRequestCreationInterceptor?: unknown;
    }

    Hierarchy (View Summary)

    Index

    Properties

    fetchOptionsInterceptor?: unknown
    lintingFix?: void
    networkUsage?: NetworkUsageSettings
    stats?: GroupStat

    A statistics group the WebSocket traffic is reported in (StatsOverlay)

    upload?: { useHttp?: boolean }

    Type Declaration

    • OptionaluseHttp?: boolean

      Whether uploads are POSTed to /upload instead of sent over the WebSocket; default false in the browser, true in Node.js (which has no WebSocket upload)

    websocket?: {
        compressed?: boolean;
        initialReconnectTimeout?: number;
        maxReconnects?: number;
        reconnectIncreaseFactor?: number;
    }

    Type Declaration

    • Optionalcompressed?: boolean

      Whether messages are sent compressed; default false

    • OptionalinitialReconnectTimeout?: number
    • OptionalmaxReconnects?: number
    • OptionalreconnectIncreaseFactor?: number
    xmlHttpRequestCreationInterceptor?: unknown