Class RequestFactory`Internal`

Factory method patterns for creating Axios Requests.

Index

Constructors

Properties

Methods

get post request

Constructors

constructor

new RequestFactory(ctx: MailcowClient): RequestFactory
Parameters
- ctx: MailcowClient
Returns RequestFactory
- Defined in src/request-factory.ts:51

Properties

`Private`ctx

ctx: MailcowClient

Methods

get

get<T>(route: string): Promise<T>
GET Request Factory
Type Parameters
- T
Parameters
- route: string
  The route to which to send the request.
Returns Promise<T>
- Defined in src/request-factory.ts:88

post

post<T, P extends object>(route: string, payload: P): Promise<T>
POST Request Factory
Type Parameters
- T
- P extends object
Parameters
- route: string
  The route to which to send the request.
- payload: P
  The payload to send with the request.
Returns Promise<T>
- Defined in src/request-factory.ts:80

`Private`request

request<T>(send: () => Promise<AxiosResponse<T, any, {}>>): Promise<T>
Executes a request and applies Mailcow-specific error handling: a 2XX response with type: 'danger' or type: 'error' is converted into a MailcowException, and an axios error whose response body looks like a Mailcow error is unwrapped into a MailcowException as well.
Type Parameters
- T
Parameters
- send: () => Promise<AxiosResponse<T, any, {}>>
Returns Promise<T>
- Defined in src/request-factory.ts:61