SW Combine SDK
    Preparing search index...

    Class HttpClient

    HTTP client that handles requests, retries, and token refresh

    Index

    Constructors

    constructor

    Methods

    delete get getRateLimitInfo post put request setRateLimitCallback setTokenManager

    Constructors

    Methods

    • Make a DELETE request

      Type Parameters

      • T = any

      Parameters

      • url: string
      • Optionalconfig: AxiosRequestConfig<any>

      Returns Promise<T>

    • Make a GET request

      Type Parameters

      • T = any

      Parameters

      • url: string
      • Optionalconfig: AxiosRequestConfig<any>

      Returns Promise<T>

    • Get the last known rate limit information from API response headers. Returns null if no rate limit info has been received yet.

      Returns RateLimitInfo | null

      const rateLimits = client.getRateLimitInfo();
      if (rateLimits) {
        console.log(`${rateLimits.remaining}/${rateLimits.limit} requests remaining`);
        console.log(`Resets at: ${rateLimits.resetTime}`);
      }

    post

    • post<T = any>(
          url: string,
          data?: any,
          config?: AxiosRequestConfig<any>,
      ): Promise<T>

      Make a POST request

      Type Parameters

      • T = any

      Parameters

      • url: string
      • Optionaldata: any
      • Optionalconfig: AxiosRequestConfig<any>

      Returns Promise<T>

    • Make a PUT request

      Type Parameters

      • T = any

      Parameters

      • url: string
      • Optionaldata: any
      • Optionalconfig: AxiosRequestConfig<any>

      Returns Promise<T>

    • Make a custom request

      Type Parameters

      • T = any

      Parameters

      • config: AxiosRequestConfig

      Returns Promise<T>

    • Set a callback to be notified when rate limit info is updated.

      Parameters

      Returns void

      client.setRateLimitCallback((info) => {
        if (info.remaining < 100) {
          console.warn(`Warning: Only ${info.remaining} API requests remaining!`);
        }
      });

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods