HttpClient class
A lightweight HTTP client built on native fetch.
Constructors
| Http |
Creates an HTTP client. |
Properties
| baseURL | Gets the base URL used for relative requests. |
| default |
Gets the normalized default request headers. |
Methods
| get<T>(string, Partial<Http |
Sends an HTTP request, defaulting to GET. |
| request<T>(Http |
Sends an HTTP request. |
| set |
Sets a default request header. |
Constructor Details
HttpClient(HttpClientOptions)
Creates an HTTP client.
new HttpClient(options?: HttpClientOptions)Parameters
- options
- HttpClientOptions
The base URL and default headers.
Property Details
baseURL
Gets the base URL used for relative requests.
string baseURLProperty Value
string
defaultHeaders
Gets the normalized default request headers.
Record<string, string> defaultHeadersProperty Value
Record<string, string>
Method Details
get<T>(string, Partial<HttpRequestConfig>)
Sends an HTTP request, defaulting to GET.
function get<T>(url: string, options?: Partial<HttpRequestConfig>): Promise<HttpResponse<T>>Parameters
- url
-
string
The absolute URL or path relative to the client's base URL.
- options
-
Partial<HttpRequestConfig>
Additional request options. The method and url options override the defaults.
Returns
Promise<HttpResponse<T>>
The response with its parsed body.
request<T>(HttpRequestConfig)
Sends an HTTP request.
function request<T>(config: HttpRequestConfig): Promise<HttpResponse<T>>Parameters
- config
- HttpRequestConfig
The request configuration.
Returns
Promise<HttpResponse<T>>
The response with its parsed body.
setHeader(string, string)
Sets a default request header.
function setHeader(name: string, value: string)Parameters
- name
-
string
The header name.
- value
-
string
The header value.