@izak0s/spacebring-api - v7.1.0
    Preparing search index...

    Interface SpacebringConfig

    interface SpacebringConfig {
        clientId: string;
        clientSecret: string;
        networkId?: string;
        baseUrl?: string;
        fetch?: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        maxRetries?: number;
        timeoutMs?: number;
    }
    Index
    clientId clientSecret networkId? baseUrl? fetch? maxRetries? timeoutMs?
    clientId: string

    Client ID from Spacebring > Network Settings > Developers.

    clientSecret: string

    Client secret from Spacebring > Network Settings > Developers.

    networkId?: string

    Network ID, sent as the spacebring-network-id header on every request.

    baseUrl?: string

    API origin. Defaults to https://api.spacebring.com.

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

    Custom fetch implementation (testing, non-standard platforms).

    Type Declaration

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

      • MDN Reference

        Parameters

        • input: RequestInfo | URL
        • 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>

    maxRetries?: number

    How many times to retry a failed request. Retried: 429 rate limits (any method — the API allows 10 requests/second and did not process the request), plus 502/503/504 responses, network errors, and timeouts on idempotent methods only (GET/HEAD/PUT/DELETE/OPTIONS — a gateway error may have reached the API, so POSTs are never replayed). Waits per the Retry-After header (seconds or HTTP-date), or with exponential backoff when absent. Defaults to 3; 0 disables.

    timeoutMs?: number

    Timeout per request attempt in milliseconds (each retry attempt gets a fresh budget). Timed-out attempts reject with a TimeoutError and are retried like network errors. Off by default. Uses AbortSignal.timeout; combining with a caller-supplied signal needs AbortSignal.any (Node >= 20.3, all modern browsers/workers).

    Settings
    Member Visibility

    On This Page
    Properties