A handler used for HTTP requests.

Hierarchy

  • RequestHandler

Constructors

Properties

_apiBaseUrl: string
_apiKey: string
_ratelimits: {
    [route: string]: Bucket;
} = {}

Type declaration

_requestOptions: AxiosRequestConfig<any>

Methods

  • Parameters

    • route: string
    • headers: Partial<RawAxiosHeaders & {
          Cache-Control: AxiosHeaderValue;
          Content-Encoding: AxiosHeaderValue;
          Content-Length: AxiosHeaderValue;
          Content-Type: AxiosHeaderValue;
          Server: AxiosHeaderValue;
      } & {
          set-cookie: string[];
      }>

    Returns void

  • Parameters

    • response: any
    • rejectFunc: ((e) => void)
        • (e): void
        • Parameters

          • e: Error

          Returns void

    Returns void

  • A shortcut for a GET request.

    Parameters

    • route: string

      The route to request

    • payload: any = {}

      The data to send with the request

    • requestOptions: AxiosRequestConfig<any> = {}

      Optional additional configuration for Axios

    Returns Promise<unknown>

  • A shortcut for a POST request.

    Parameters

    • route: string

      The route to request

    • payload: any = {}

      The data to send with the request

    • requestOptions: AxiosRequestConfig<any> = {}

      Optional additional configuration for Axios

    Returns Promise<unknown>

  • Send a HTTP request

    Parameters

    • method: "GET" | "POST"

      The HTTP method

    • route: string

      The route to request

    • payload: any = {}

      The data to send with the request

    • requestOptions: AxiosRequestConfig<any> = {}

      Optional additional configuration for Axios

    Returns Promise<unknown>