Class HttpClient

Handle HTTP requests with a uniform interface.

Hierarchy

  • HttpClient

Constructors

constructor

Properties

DEFAULT_REQUEST DEFAULT_TIMEOUT HTTPS_AGENT HTTP_AGENT MAX_REQUESTS_PER_SECOND MAX_TIMEOUT PROMISE_THROTTLES TASK_QUEUES axiosDigestAuthRequest

Methods

getHttpAgent getHttpsAgent request requestAxios

Constructors

constructor

Properties

Static Protected DEFAULT_REQUEST

DEFAULT_REQUEST: {
    method: string;
    rejectUnauthorized: boolean;
    resolveWithFullResponse: boolean;
} = ...

Type declaration

  • method: string
  • rejectUnauthorized: boolean
  • resolveWithFullResponse: boolean

Static Protected DEFAULT_TIMEOUT

DEFAULT_TIMEOUT: number = 60000

Static Protected HTTPS_AGENT

HTTPS_AGENT: any

Static Protected HTTP_AGENT

HTTP_AGENT: any

Static MAX_REQUESTS_PER_SECOND

MAX_REQUESTS_PER_SECOND: number = 50

Static MAX_TIMEOUT

MAX_TIMEOUT: number = 2147483647

Static Protected PROMISE_THROTTLES

PROMISE_THROTTLES: any[] = []

Static Protected TASK_QUEUES

TASK_QUEUES: any[] = []

Static Protected axiosDigestAuthRequest

axiosDigestAuthRequest: ((method, url, username, password, body) => Promise<AxiosResponse<any, any>>) = ...

Type declaration

    • (method, url, username, password, body): Promise<AxiosResponse<any, any>>

    • Parameters

      • method: any
      • url: any
      • username: any
      • password: any
      • body: any

      Returns Promise<AxiosResponse<any, any>>

Methods

Static Protected getHttpAgent

  • Get a singleton instance of an HTTP client to share.

    Returns any

    a shared agent for network requests among library instances

Static Protected getHttpsAgent

  • Get a singleton instance of an HTTPS client to share.

    Returns any

    a shared agent for network requests among library instances

Static request

  • Make a HTTP request.

    Parameters

    • request: any

      configures the request to make

    Returns Promise<any>

    response - the response object

Static Protected requestAxios

  • Parameters

    • req: any

    Returns Promise<any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc