Class AWSHttpRequestBuilder

Class to build and execute HTTP requests with AWS signing

Example

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

Index

Constructors

constructor

new AWSHttpRequestBuilder(tokenStorage, config, axiosInstance?): AWSHttpRequestBuilder
Creates an instance of AWSHttpRequestBuilder.
Parameters
- tokenStorage: AWSStorageService
  The AWS storage service for token management.
- config: AxiosRequestConfig<any, any>
  The Axios request configuration.
- Optional axiosInstance: AxiosInstance
  The Axios instance.
Returns AWSHttpRequestBuilder
Throws
If tokenStorage, method, or baseURL are not defined.
- Defined in http/aws-http-request.builder.ts:37

Properties

`Private` axiosInstance

axiosInstance: AxiosInstance

`Private` config

config: AxiosRequestConfig<any, any> = ...

`Private` logger

logger: LoggerService

`Private` `Readonly` tokenStorage

tokenStorage: AWSStorageService

The AWS storage service for token management.

Methods

addAxiosRequestConfig

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

addHeaders

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

`Private` addXLemonIdentityToHeader

addXLemonIdentityToHeader(header): Promise<AxiosHeaders>
Adds x-lemon-identity to the header.
Parameters
- header: any
  The header to be added
Returns Promise<AxiosHeaders>
The header with x-lemon-identity added
- Defined in http/aws-http-request.builder.ts:209

`Private` addXLemonLanguageToHeader

addXLemonLanguageToHeader(header): Promise<AxiosHeaders>
Adds x-lemon-language to the header.
Parameters
- header: any
  The header to be added
Returns Promise<AxiosHeaders>
The header with x-lemon-language added
- Defined in http/aws-http-request.builder.ts:227

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/aws-http-request.builder.ts:122

`Private` extractHostname

extractHostname(url): string
Private
Extracts the hostname from a URL.
Parameters
- url: string
  The URL to extract the hostname from.
Returns string
- The extracted hostname.
- Defined in http/aws-http-request.builder.ts:246

`Private` getSignedClient

getSignedClient(endpoint?): Promise<any>
Private
Gets the signed AWS client.
Parameters
- Optional endpoint: string
  The endpoint for the client.
Returns Promise<any>
- The signed AWS client, or false when token storage holds no credentials, in which case the request goes out unsigned.
Throws
If endpoint is not provided.
- Defined in http/aws-http-request.builder.ts:146

`Private` getSignedHeader

getSignedHeader(signedClient, data): Promise<any>
Private
Gets the signed headers for the request.
Parameters
- signedClient: any
  The signed AWS client.
- data: HttpRequestData
  The request data.
Returns Promise<any>
- The signed headers.
- Defined in http/aws-http-request.builder.ts:178

setBody

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

setHeaders

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

setMethod

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

setParams

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

Class AWSHttpRequestBuilder

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AWSHttpRequestBuilder

Throws

Properties

Private axiosInstance

Private config

Private logger

Private Readonly tokenStorage

Methods

addAxiosRequestConfig

Parameters

Returns AWSHttpRequestBuilder

addHeaders

Parameters

Returns AWSHttpRequestBuilder

Private addXLemonIdentityToHeader

Parameters

Returns Promise<AxiosHeaders>

Private addXLemonLanguageToHeader

Parameters

Returns Promise<AxiosHeaders>

execute

Type Parameters

Returns Promise<HttpResponse<T>>

Throws

Private extractHostname

Parameters

Returns string

Private getSignedClient

Parameters

Returns Promise<any>

Throws

Private getSignedHeader

Parameters

Returns Promise<any>

setBody

Parameters

Returns AWSHttpRequestBuilder

setHeaders

Parameters

Returns AWSHttpRequestBuilder

setMethod

Parameters

Returns AWSHttpRequestBuilder

setParams

Parameters

Returns AWSHttpRequestBuilder

Settings

Member Visibility

Theme

On This Page

`Private` axiosInstance

`Private` config

`Private` logger

`Private` `Readonly` tokenStorage

`Private` addXLemonIdentityToHeader

`Private` addXLemonLanguageToHeader

`Private` extractHostname

`Private` getSignedClient

`Private` getSignedHeader