Class API

Transport.API class handles communication with API

Hierarchy

API

Index

Constructors

constructor

Properties

config

Methods

Constructors

constructor

new API(clientConfig: ClientConfig): API

- Defined in modules/Transport.ts:40
Transport.API class handles communication with API

Parameters
- clientConfig: ClientConfig
  
  Client Configuration
Returns API

Properties

Protected config

config: ClientConfig

Client Configuration

Methods

getFromApiRoute

getFromApiRoute(route: Route, headers?: object): Promise<AxiosResponse>

- Defined in modules/Transport.ts:59
Triggers a GET request to an API route

Parameters
- route: Route
  
  API route
- Optional headers: object
  
  Optional headers to send in request
Returns Promise<AxiosResponse>

A Promise that resolves to an axios response

postToApiRoute

postToApiRoute(route: Route, data: object, headers?: object): Promise<AxiosResponse>

- Defined in modules/Transport.ts:79
Triggers a POST request to an API route

Parameters
- route: Route
  
  API route
- data: object
  
  data object to send in POST request
- Optional headers: object
  
  Optional headers to send in request
Returns Promise<AxiosResponse>

A Promise that resolves to an axios response

putToApiRoute

putToApiRoute(route: Route, data: object, headers?: object): Promise<AxiosResponse>

- Defined in modules/Transport.ts:99
Triggers a PUT request to an API route

Parameters
- route: Route
  
  API route
- data: object
  
  data object to send in POST request
- Optional headers: object
  
  Optional headers to send in request
Returns Promise<AxiosResponse>

A Promise that resolves to an axios response

requestToApi

requestToApi(request: RequestConfig): Promise<AxiosResponse>

- Defined in modules/Transport.ts:117
Triggers a request to API

Parameters
- request: RequestConfig
Returns Promise<AxiosResponse>

A promise that resolves to an axios response

Generated using TypeDoc