Class BasicHttpClient

Hierarchy

BasicHttpClient
- RetryableHttpClient

Index

Constructors

constructor

Methods

Constructors

constructor

new BasicHttpClient(baseUrl: string): BasicHttpClient

- Defined in packages/core/src/httpClient/basicHttpClient.ts:78
A basic http client with the option of adding default headers, and the option of using a baseUrl. Note: If the path given starts with https://, the baseUrl is ignored.

It handles query parameters, and request body data which gets encoded as json if needed.

See HttpRequest.

Parameters
- baseUrl: string
Returns BasicHttpClient

Methods

delete

delete<ResponseType>(path: string, options?: HttpRequestOptions): Promise<HttpResponse<ResponseType>>

- Defined in packages/core/src/httpClient/basicHttpClient.ts:140
Type parameters
- ResponseType
Parameters
- path: string
- Default value options: HttpRequestOptions = {}
Returns Promise<HttpResponse<ResponseType>>

get

get<ResponseType>(path: string, options?: HttpRequestOptions): Promise<HttpResponse<ResponseType>>

- Defined in packages/core/src/httpClient/basicHttpClient.ts:115
Type parameters
- ResponseType
Parameters
- path: string
- Default value options: HttpRequestOptions = {}
Returns Promise<HttpResponse<ResponseType>>

getBaseUrl

getBaseUrl(): string

- Defined in packages/core/src/httpClient/basicHttpClient.ts:107
Returns string

getDefaultHeaders

getDefaultHeaders(): HttpHeaders

- Defined in packages/core/src/httpClient/basicHttpClient.ts:99
Returns HttpHeaders

patch

patch<ResponseType>(path: string, options?: HttpRequestOptions): Promise<HttpResponse<ResponseType>>

- Defined in packages/core/src/httpClient/basicHttpClient.ts:148
Type parameters
- ResponseType
Parameters
- path: string
- Default value options: HttpRequestOptions = {}
Returns Promise<HttpResponse<ResponseType>>

post

post<ResponseType>(path: string, options?: HttpRequestOptions): Promise<HttpResponse<ResponseType>>

- Defined in packages/core/src/httpClient/basicHttpClient.ts:124
Type parameters
- ResponseType
Parameters
- path: string
- Default value options: HttpRequestOptions = {}
Returns Promise<HttpResponse<ResponseType>>

put

put<ResponseType>(path: string, options?: HttpRequestOptions): Promise<HttpResponse<ResponseType>>

- Defined in packages/core/src/httpClient/basicHttpClient.ts:132
Type parameters
- ResponseType
Parameters
- path: string
- Default value options: HttpRequestOptions = {}
Returns Promise<HttpResponse<ResponseType>>

setBaseUrl

setBaseUrl(baseUrl: string): void

- Defined in packages/core/src/httpClient/basicHttpClient.ts:103
Parameters
- baseUrl: string
Returns void

setCluster

setCluster(cluster: string): void

- Defined in packages/core/src/httpClient/basicHttpClient.ts:111
Parameters
- cluster: string
Returns void

setDefaultHeader

setDefaultHeader(name: string, value: string): this

- Defined in packages/core/src/httpClient/basicHttpClient.ts:94
Parameters
- name: string
- value: string
Returns this