thesportsdb-client
    Preparing search index...

    Interface SportsDbOptions

    interface SportsDbOptions {
        apiKey?: string;
        baseUrl?: string;
        cache?: ResponseCache;
        cachePolicy?: Partial<CachePolicy>;
        clock?: Clock;
        deduplicateRequests?: boolean;
        maxRetries?: number;
        rateLimitWaitMs?: number;
        requestListener?: (event: RequestEvent) => void;
        requestsPerMinute?: number;
        retryBackoffMs?: number;
        retryOnRateLimit?: boolean;
        timeoutMs?: number;
        transport?: Transport;
        userAgent?: string;
    }
    Index
    apiKey? baseUrl? cache? cachePolicy? clock? deduplicateRequests? maxRetries? rateLimitWaitMs? requestListener? requestsPerMinute? retryBackoffMs? retryOnRateLimit? timeoutMs? transport? userAgent?
    apiKey?: string

    Your API key. Default: the free key "123".

    baseUrl?: string
    cache?: ResponseCache

    Optional response cache.

    cachePolicy?: Partial<CachePolicy>

    Time-to-live per kind of data, in ms.

    clock?: Clock

    For tests.

    deduplicateRequests?: boolean

    Identical calls made at the same time share one HTTP request. Default true.

    maxRetries?: number

    Retries for network errors and HTTP 5xx, with exponential backoff. Default 2.

    rateLimitWaitMs?: number

    Default 60000.

    requestListener?: (event: RequestEvent) => void

    Called once per call, after it finishes. Errors it throws are ignored.

    requestsPerMinute?: number

    Client-side limit; default 30 for a free key, 100 otherwise; 0 turns it off.

    retryBackoffMs?: number

    First backoff in ms; doubles on every retry. Default 500.

    retryOnRateLimit?: boolean

    On HTTP 429, wait (Retry-After, or rateLimitWaitMs) and retry once. Default true.

    timeoutMs?: number

    Per request, in ms; applies to the default transport. Default 30000.

    transport?: Transport

    Default the global fetch with timeoutMs.

    userAgent?: string

    Sent as User-Agent (ignored by browsers).

    Settings
    Member Visibility

    On This Page
    Properties