Class: ApiClient

Constructor

new ApiClient(httpClient, instanceConfig)

ApiClient constructor

Parameters:

Name	Type	Description
`httpClient`	Object \| Axios	Http client or axios instance
`instanceConfig`	AxiosRequestConfig \| Object	Config defaults for the instance

Source: api-client.js, line 7

Members

defaults

Returns default configuration

Source: api-client.js, line 30

defaults

Set default configuration value

Source: api-client.js, line 57

Example

import axios from 'axios';

const apiClient = new ApiClient(axios);

apiClient.defaults.headers.common['X-Test'] = 'test';
api.defaults.baseURL = 'https://example.com';
api.defaults.timeout = 100;

console.log(api.defaults.headers.common['X-Test'])
test

console.log(api.defaults.baseURL)
https://example.com

console.log(api.defaults.timeout)
100

interceptors

Interceptors getter

Source: api-client.js, line 66

Methods

addRequestInterceptor(onFulfilled, onRejectedopt) → {Number}

Add a request interceptor

Parameters:

Name	Type	Attributes	Default	Description
`onFulfilled`	function			Any status code that lie within the range of 2xx cause this function to trigger
`onRejected`	function	<optional>	null	Any status codes that falls outside the range of 2xx cause this function to trigger

Source: api-client.js, line 82

Returns:

An ID used to remove interceptor later

Type:: Number

addResponseInterceptor(onFulfilled, onRejectedopt) → {Number}

Add a response interceptor

Parameters:

Name	Type	Attributes	Default	Description
`onFulfilled`	function			Any status code that lie within the range of 2xx cause this function to trigger
`onRejected`	function	<optional>	null	Any status codes that falls outside the range of 2xx cause this function to trigger

Source: api-client.js, line 103

Returns:

An ID used to remove interceptor later

Type:: Number

delete(url, configopt) → {Promise.<AxiosResponse.<any>>}

Performs DELETE Request

Parameters:

Name	Type	Attributes	Default	Description
`url`	String			Request url Request url
`config`	Object	<optional>	{}	Request config

Source: api-client.js, line 158

Returns:

Type:: Promise.<AxiosResponse.<any>>

get(url, configopt) → {Promise.<AxiosResponse.<any>>}

Performs GET Request

Parameters:

Name	Type	Attributes	Default	Description
`url`	String			Request url Request url
`config`	Object	<optional>	{}	Request config

Source: api-client.js, line 147

Returns:

Type:: Promise.<AxiosResponse.<any>>

getUri(configopt) → {string}

Returns the URL for making request

Parameters:

Name	Type	Attributes	Description
`config`	Object	<optional>	The config specific for this request (merged with defaults)

Source: api-client.js, line 122

Returns:

Type:: string

head(url, configopt) → {Promise.<AxiosResponse.<any>>}

Performs HEAD Request

Parameters:

Name	Type	Attributes	Default	Description
`url`	String			Request url Request url
`config`	Object	<optional>	{}	Request config

Source: api-client.js, line 169

Returns:

Type:: Promise.<AxiosResponse.<any>>

options(url, configopt) → {Promise.<AxiosResponse.<any>>}

Performs OPTIONS Request

Parameters:

Name	Type	Attributes	Default	Description
`url`	String			Request url Request url
`config`	Object	<optional>	{}	Request config

Source: api-client.js, line 180

Returns:

Type:: Promise.<AxiosResponse.<any>>

patch(url, dataopt, configopt) → {Promise.<AxiosResponse.<any>>}

Performs PATCH Request

Parameters:

Name	Type	Attributes	Default	Description
`url`	String			Request url
`data`	string \| Object \| ArrayBuffer \| ArrayBufferView \| URLSearchParams \| FormData \| File \| Blob \| Stream \| Buffer	<optional>	null	The data to be sent as the request body. Browser only: FormData, File, Blob. Node only: Stream, Buffer.
`config`	Object	<optional>	{}	Request config

Source: api-client.js, line 216

Returns:

Type:: Promise.<AxiosResponse.<any>>

patchForm(url, dataopt, configopt) → {Promise.<axios.AxiosResponse.<any>>}

Performs PATCH Request with FormData

Parameters:

Name	Type	Attributes	Default	Description
`url`	String			Request url
`data`	string \| Object \| ArrayBuffer \| ArrayBufferView \| URLSearchParams \| FormData \| File \| Blob \| Stream \| Buffer	<optional>	null	The data to be sent as the request body. Browser only: FormData, File, Blob. Node only: Stream, Buffer.
`config`	Object	<optional>	{}	Request config

Source: api-client.js, line 252

Returns:

Type:: Promise.<axios.AxiosResponse.<any>>

post(url, dataopt, configopt) → {Promise.<AxiosResponse.<any>>}

Performs POST Request

Parameters:

Name	Type	Attributes	Default	Description
`url`	String			Request url
`data`	string \| Object \| ArrayBuffer \| ArrayBufferView \| URLSearchParams \| FormData \| File \| Blob \| Stream \| Buffer	<optional>	null	The data to be sent as the request body. Browser only: FormData, File, Blob. Node only: Stream, Buffer.
`config`	Object	<optional>	{}	Request config

Source: api-client.js, line 192

Returns:

Type:: Promise.<AxiosResponse.<any>>

postForm(url, dataopt, configopt) → {Promise.<axios.AxiosResponse.<any>>}

Performs POST Request with FormData

Parameters:

Name	Type	Attributes	Default	Description
`url`	String			Request url
`data`	string \| Object \| ArrayBuffer \| ArrayBufferView \| URLSearchParams \| FormData \| File \| Blob \| Stream \| Buffer	<optional>	null	The data to be sent as the request body. Browser only: FormData, File, Blob. Node only: Stream, Buffer.
`config`	Object	<optional>	{}	Request config

Source: api-client.js, line 228

Returns:

Type:: Promise.<axios.AxiosResponse.<any>>

put(url, dataopt, configopt) → {Promise.<AxiosResponse.<any>>}

Performs PUT Request

Parameters:

Name	Type	Attributes	Default	Description
`url`	String			Request url
`data`	string \| Object \| ArrayBuffer \| ArrayBufferView \| URLSearchParams \| FormData \| File \| Blob \| Stream \| Buffer	<optional>	null	The data to be sent as the request body. Browser only: FormData, File, Blob. Node only: Stream, Buffer.
`config`	Object	<optional>	{}	Request config

Source: api-client.js, line 204

Returns:

Type:: Promise.<AxiosResponse.<any>>

putForm(url, dataopt, configopt) → {Promise.<axios.AxiosResponse.<any>>}

Performs PUT Request with FormData

Parameters:

Name	Type	Attributes	Default	Description
`url`	String			Request url
`data`	string \| Object \| ArrayBuffer \| ArrayBufferView \| URLSearchParams \| FormData \| File \| Blob \| Stream \| Buffer	<optional>	null	The data to be sent as the request body. Browser only: FormData, File, Blob. Node only: Stream, Buffer.
`config`	Object	<optional>	{}	Request config