Class AmqpAxiosProxiedClient

An instance of axios which is preconfigured to use the AMQP adapter.

Hierarchy

AmqpAxiosProxiedClient

Implements

Axios

Index

Constructors

constructor

new AmqpAxiosProxiedClient(queueName, connection, config?): AmqpAxiosProxiedClient
Creates an instance of AmqpAxiosProxiedClient.
Parameters
- queueName: string
  
  The name of the queue which will be used to send requests to the worker.
- connection: AmqplibAxiosAdapterManagerConfiguration
  
  The amqplib-oop connection options or an instance of a connection
- config: AmqpAxiosProxiedClientConfig<any> = {}
  
  The default configuration which you want to provide to the axios instance.
Returns AmqpAxiosProxiedClient
- Defined in src/client.ts:40

Accessors

defaults

get defaults(): AxiosDefaults<any>
Configuration defaults which can be applied to every request.

Returns AxiosDefaults<any>

See
https://axios-http.com/docs/config_defaults
Implementation of Axios.defaults
- Defined in src/client.ts:58

interceptors

get interceptors(): {
request: AxiosInterceptorManager<InternalAxiosRequestConfig<any>>;
response: AxiosInterceptorManager<AxiosResponse<any, any>>;
}
Hooks which allow the modification of requests before they are sent to the server, and responses before they are returned to the caller.

Returns {
request: AxiosInterceptorManager<InternalAxiosRequestConfig<any>>;
response: AxiosInterceptorManager<AxiosResponse<any, any>>;
}
- request: AxiosInterceptorManager<InternalAxiosRequestConfig<any>>
- response: AxiosInterceptorManager<AxiosResponse<any, any>>
Implementation of Axios.interceptors
- Defined in src/client.ts:66

Methods

delete

delete<T, R, D>(url, config?): Promise<R>
Make an HTTP DELETE request to the specified URL.
Type Parameters
- T = any
  
  the type defining the shape of the response payload
- R = AxiosResponse<T, any>
  
  the type defining the shape of the full axios response
- D = any
  
  the type defining the shape of the request payload
Parameters
- url: string
  
  The url for the request
- Optional config: AmqpAxiosProxiedClientConfig<D>
  
  The configuration for the request
Returns Promise<R>
The response for the request

Throws
If the request fails
Implementation of Axios.delete
- Defined in src/client.ts:124

get

get<T, R, D>(url, config?): Promise<R>
Make an HTTP GET request to the specified URL.
Type Parameters
- T = any
  
  the type defining the shape of the response payload
- R = AxiosResponse<T, any>
  
  the type defining the shape of the full axios response
- D = any
  
  the type defining the shape of the request payload
Parameters
- url: string
  
  The url for the request
- Optional config: AmqpAxiosProxiedClientConfig<D>
  
  The configuration for the request
Returns Promise<R>
The response for the request

Throws
If the request fails
Implementation of Axios.get
- Defined in src/client.ts:107

getUri

getUri(config?): string
Resolve the url for the request based on the config.
Parameters
- Optional config: AxiosRequestConfig<any>
  
  The configuration for the request
Returns string
The url for the request
Implementation of Axios.getUri
- Defined in src/client.ts:78

head

head<T, R, D>(url, config?): Promise<R>
Make an HTTP HEAD request to the specified URL.
Type Parameters
- T = any
  
  the type defining the shape of the response payload
- R = AxiosResponse<T, any>
  
  the type defining the shape of the full axios response
- D = any
  
  the type defining the shape of the request payload
Parameters
- url: string
  
  The url for the request
- Optional config: AmqpAxiosProxiedClientConfig<D>
  
  The configuration for the request
Returns Promise<R>
The response for the request

Throws
If the request fails
Implementation of Axios.head
- Defined in src/client.ts:141

options

options<T, R, D>(url, config?): Promise<R>
Make an HTTP OPTIONS request to the specified URL.
Type Parameters
- T = any
  
  the type defining the shape of the response payload
- R = AxiosResponse<T, any>
  
  the type defining the shape of the full axios response
- D = any
  
  the type defining the shape of the request payload
Parameters
- url: string
  
  The url for the request
- Optional config: AmqpAxiosProxiedClientConfig<D>
  
  The configuration for the request
Returns Promise<R>
The response for the request

Throws
If the request fails
Implementation of Axios.options
- Defined in src/client.ts:158

patch

patch<T, R, D>(url, data?, config?): Promise<R>
Make an HTTP PATCH request to the specified URL with the specified payload
Type Parameters
- T = any
  
  the type defining the shape of the response payload
- R = AxiosResponse<T, any>
  
  the type defining the shape of the full axios response
- D = any
  
  the type defining the shape of the request payload
Parameters
- url: string
  
  The url for the request
- Optional data: any
- Optional config: AmqpAxiosProxiedClientConfig<D>
  
  The configuration for the request
Returns Promise<R>
The response for the request

Throws
If the request fails
Implementation of Axios.patch
- Defined in src/client.ts:211

patchForm

patchForm<T, R, D>(url, data?, config?): Promise<R>
Make an HTTP PATCH request with the content-type set to application/x-www-form-urlencoded to the specified URL with the specified payload
Type Parameters
- T = any
  
  the type defining the shape of the response payload
- R = AxiosResponse<T, any>
  
  the type defining the shape of the full axios response
- D = any
  
  the type defining the shape of the request payload
Parameters
- url: string
  
  The url for the request
- Optional data: any
- Optional config: AmqpAxiosProxiedClientConfig<D>
  
  The configuration for the request
Returns Promise<R>
The response for the request

Throws
If the request fails
Implementation of Axios.patchForm
- Defined in src/client.ts:265

post

post<T, R, D>(url, data?, config?): Promise<R>
Make an HTTP POST request to the specified URL with the specified payload
Type Parameters
- T = any
  
  the type defining the shape of the response payload
- R = AxiosResponse<T, any>
  
  the type defining the shape of the full axios response
- D = any
  
  the type defining the shape of the request payload
Parameters
- url: string
  
  The url for the request
- Optional data: any
- Optional config: AmqpAxiosProxiedClientConfig<D>
  
  The configuration for the request
Returns Promise<R>
The response for the request

Throws
If the request fails
Implementation of Axios.post
- Defined in src/client.ts:175

postForm

postForm<T, R, D>(url, data?, config?): Promise<R>
Make an HTTP POST request with the content-type set to application/x-www-form-urlencoded to the specified URL with the specified payload
Type Parameters
- T = any
  
  the type defining the shape of the response payload
- R = AxiosResponse<T, any>
  
  the type defining the shape of the full axios response
- D = any
  
  the type defining the shape of the request payload
Parameters
- url: string
  
  The url for the request
- Optional data: any
- Optional config: AmqpAxiosProxiedClientConfig<D>
  
  The configuration for the request
Returns Promise<R>
The response for the request

Throws
If the request fails
Implementation of Axios.postForm
- Defined in src/client.ts:229

put

put<T, R, D>(url, data?, config?): Promise<R>
Make an HTTP PUT request to the specified URL with the specified payload
Type Parameters
- T = any
  
  the type defining the shape of the response payload
- R = AxiosResponse<T, any>
  
  the type defining the shape of the full axios response
- D = any
  
  the type defining the shape of the request payload
Parameters
- url: string
  
  The url for the request
- Optional data: any
- Optional config: AmqpAxiosProxiedClientConfig<D>
  
  The configuration for the request
Returns Promise<R>
The response for the request

Throws
If the request fails
Implementation of Axios.put
- Defined in src/client.ts:193

putForm

putForm<T, R, D>(url, data?, config?): Promise<R>
Make an HTTP PUT request with the content-type set to application/x-www-form-urlencoded to the specified URL with the specified payload
Type Parameters
- T = any
  
  the type defining the shape of the response payload
- R = AxiosResponse<T, any>
  
  the type defining the shape of the full axios response
- D = any
  
  the type defining the shape of the request payload
Parameters
- url: string
  
  The url for the request
- Optional data: any
- Optional config: AmqpAxiosProxiedClientConfig<D>
  
  The configuration for the request
Returns Promise<R>
The response for the request

Throws
If the request fails
Implementation of Axios.putForm
- Defined in src/client.ts:247

request

request<T, R, D>(config): Promise<R>
Type Parameters
- T = any
  
  the type defining the shape of the response payload
- R = AxiosResponse<T, any>
  
  the type defining the shape of the full axios response
- D = any
  
  the type defining the shape of the request payload Make a with the method & url specified in the config.
Parameters
- config: AmqpAxiosProxiedClientConfig<D>
  
  The configuration for the request
Returns Promise<R>
The response for the request

Throws
If the request fails
Implementation of Axios.request
- Defined in src/client.ts:91

Class AmqpAxiosProxiedClient

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

queueName: string

connection: AmqplibAxiosAdapterManagerConfiguration

config: AmqpAxiosProxiedClientConfig<any> = {}

Returns AmqpAxiosProxiedClient

Accessors

defaults

Returns AxiosDefaults<any>

See

interceptors

Returns { request: AxiosInterceptorManager<InternalAxiosRequestConfig<any>>; response: AxiosInterceptorManager<AxiosResponse<any, any>>; }

request: AxiosInterceptorManager<InternalAxiosRequestConfig<any>>

response: AxiosInterceptorManager<AxiosResponse<any, any>>

Methods

delete

Type Parameters

T = any

R = AxiosResponse<T, any>

D = any

Parameters

url: string

Optional config: AmqpAxiosProxiedClientConfig<D>

Returns Promise<R>

Throws

get

Type Parameters

T = any

R = AxiosResponse<T, any>

D = any

Parameters

url: string

Optional config: AmqpAxiosProxiedClientConfig<D>

Returns Promise<R>

Throws

getUri

Parameters

Optional config: AxiosRequestConfig<any>

Returns string

head

Type Parameters

T = any

R = AxiosResponse<T, any>

D = any

Parameters

url: string

Optional config: AmqpAxiosProxiedClientConfig<D>

Returns Promise<R>

Throws

options

Type Parameters

T = any

R = AxiosResponse<T, any>

D = any

Parameters

url: string

Optional config: AmqpAxiosProxiedClientConfig<D>

Returns Promise<R>

Throws

patch

Type Parameters

T = any

R = AxiosResponse<T, any>

D = any

Parameters

url: string

Optional data: any

Optional config: AmqpAxiosProxiedClientConfig<D>

Returns Promise<R>

Throws

patchForm

Type Parameters

Returns {
request: AxiosInterceptorManager<InternalAxiosRequestConfig<any>>;
response: AxiosInterceptorManager<AxiosResponse<any, any>>;
}

`Optional` config: AmqpAxiosProxiedClientConfig<D>

`Optional` config: AmqpAxiosProxiedClientConfig<D>

`Optional` config: AxiosRequestConfig<any>

`Optional` config: AmqpAxiosProxiedClientConfig<D>

`Optional` config: AmqpAxiosProxiedClientConfig<D>

`Optional` data: any

`Optional` config: AmqpAxiosProxiedClientConfig<D>

`Optional` data: any

`Optional` config: AmqpAxiosProxiedClientConfig<D>

`Optional` data: any

`Optional` config: AmqpAxiosProxiedClientConfig<D>

`Optional` data: any

`Optional` config: AmqpAxiosProxiedClientConfig<D>

`Optional` data: any

`Optional` config: AmqpAxiosProxiedClientConfig<D>

`Optional` data: any

`Optional` config: AmqpAxiosProxiedClientConfig<D>