Interface HTTPClientOptions

interface HTTPClientOptions {
    apiKey: string;
    baseUrl?: string;
    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    logger?: Logger;
    maxRetries?: number;
    rateLimit?: RateLimitOptions;
    timeout?: number;
}

Properties

apiKey baseUrl? fetch? logger? maxRetries? rateLimit? timeout?

Properties

apiKey

apiKey: string

Optional baseUrl

baseUrl?: string

Optional fetch

fetch?: {
    (input, init?): Promise<Response>;
    (input, init?): Promise<Response>;
}

Type declaration

    • (input, init?): Promise<Response>

    • MDN Reference

      Parameters

      • input: URL | RequestInfo
      • Optional init: RequestInit

      Returns Promise<Response>

    • (input, init?): Promise<Response>

    • Parameters

      • input: string | URL | Request
      • Optional init: RequestInit

      Returns Promise<Response>

Optional logger

logger?: Logger

Optional maxRetries

maxRetries?: number

Optional rateLimit

rateLimit?: RateLimitOptions

Optional timeout

timeout?: number

Settings

Member Visibility

Theme

On This Page

apiKeybaseUrlfetchloggermaxRetriesrateLimittimeout