Class HttpClient

A static helper class used to provide an interface for Promise based web requests.

Hierarchy

HttpClient

Index

Methods

Methods

Static get

get(path: string, options?: RequestOptions): Promise<string>

- Defined in services/http/http-client.ts:32
Makes a GET request to the specified path.

Parameters
- path: string
  
  The path to make the GET request to.
- Default value options: RequestOptions = { query: {}, proxy: null }
  
  The options to use while making the request.
Returns Promise<string>

Static Private getWithProxy

getWithProxy(endpoint: Url, proxy: Proxy, query: string): Promise<any>

- Defined in services/http/http-client.ts:94
Parameters
- endpoint: Url
- proxy: Proxy
- query: string
Returns Promise<any>

Static post

post(path: string, params?: object): Promise<string>

- Defined in services/http/http-client.ts:83
Makes a POST request to the specified path and passes the provided parameters.

Parameters
- path: string
  
  The path to make the POST request to.
- Optional params: object
  
  The POST parameters to include.
  - [id: string]: any
Returns Promise<string>

Static unzip

unzip(zipped: IncomingMessage): Promise<string>

- Defined in services/http/http-client.ts:56
Unzips a gzipped HTTP response.

Parameters
- zipped: IncomingMessage
  
  The gzipped response to unzip.
Returns Promise<string>

Generated using TypeDoc