Class HttpRequestBuilder

Class to build and execute HTTP requests

Example

const response: HttpResponse<OAuthResponse> = await new HttpRequestBuilder({
    method: 'GET',
    baseURL: `https://api.lemoncloud.io/v1/oauth`,
 })
   .setHeaders({ Cookie: this.cookie })
   .setParams({ page: 0 })
   .execute();

Index

Constructors

constructor

new HttpRequestBuilder(config?): HttpRequestBuilder
Parameters
- Optional config: AxiosRequestConfig<any>
  Initial configuration
Returns HttpRequestBuilder
Throws
If the method is not defined

Throws
If the baseURL is not defined
- Defined in http/http-request.builder.ts:32

Properties

`Private` axiosInstance

axiosInstance: AxiosInstance

`Private` config

config: AxiosRequestConfig<any> = ...

Methods

addAxiosRequestConfig

addAxiosRequestConfig(config): HttpRequestBuilder
Adds additional Axios request configuration.
Parameters
- config: AxiosRequestConfig<any>
  The configuration to add.
Returns HttpRequestBuilder
- Returns the current instance to allow method chaining.
- Defined in http/http-request.builder.ts:98

addHeaders

addHeaders(headers?): HttpRequestBuilder
Adds additional headers to the request.
Parameters
- headers: Headers = {}
  Headers to add.
Returns HttpRequestBuilder
- Returns the current instance to allow method chaining.
- Defined in http/http-request.builder.ts:88

execute

execute<T>(): Promise<HttpResponse<T>>
Executes the HTTP request
Type Parameters
- T
Returns Promise<HttpResponse<T>>
- Promise containing the response
Throws
If an error occurs during the request
- Defined in http/http-request.builder.ts:109

setBody

setBody(data): HttpRequestBuilder
Sets the request body
Parameters
- data: Body
  Body data to set
Returns HttpRequestBuilder
- Returns the current instance to allow method chaining
- Defined in http/http-request.builder.ts:68

setHeaders

setHeaders(headers): HttpRequestBuilder
Sets the request headers
Parameters
- headers: Headers
  Headers to set
Returns HttpRequestBuilder
- Returns the current instance to allow method chaining
- Defined in http/http-request.builder.ts:48

setMethod

setMethod(method): HttpRequestBuilder
Sets the request method
Parameters
- method: string
  HTTP method to set
Returns HttpRequestBuilder
- Returns the current instance to allow method chaining
- Defined in http/http-request.builder.ts:78

setParams

setParams(params): HttpRequestBuilder
Sets the request parameters
Parameters
- params: Params
  Parameters to set
Returns HttpRequestBuilder
- Returns the current instance to allow method chaining
- Defined in http/http-request.builder.ts:58

Class HttpRequestBuilder

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns HttpRequestBuilder

Throws

Throws

Properties

Private axiosInstance

Private config

Methods

addAxiosRequestConfig

Parameters

Returns HttpRequestBuilder

addHeaders

Parameters

Returns HttpRequestBuilder

execute

Type Parameters

Returns Promise<HttpResponse<T>>

Throws

setBody

Parameters

Returns HttpRequestBuilder

setHeaders

Parameters

Returns HttpRequestBuilder

setMethod

Parameters

Returns HttpRequestBuilder

setParams

Parameters

Returns HttpRequestBuilder

Settings

Member Visibility

Theme

On This Page

`Private` axiosInstance

`Private` config