Files
medusa-store/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosInstance.md
github-actions[bot] daea35fe73 chore(docs): Generated JS Client Reference (#5334)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-10-10 17:47:07 +00:00

6.7 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Interface: AxiosInstance

internal.AxiosInstance

Hierarchy

  • Axios

    AxiosInstance

Callable

AxiosInstance

AxiosInstance(config): AxiosPromise<any>

Parameters

Name Type
config AxiosRequestConfig<any>

Returns

AxiosPromise<any>

Defined in

packages/medusa-js/node_modules/axios/index.d.ts:188

AxiosInstance

AxiosInstance(url, config?): AxiosPromise<any>

Parameters

Name Type
url string
config? AxiosRequestConfig<any>

Returns

AxiosPromise<any>

Defined in

packages/medusa-js/node_modules/axios/index.d.ts:189

Properties

defaults

defaults: AxiosDefaults<any>

Inherited from

Axios.defaults

Defined in

packages/medusa-js/node_modules/axios/index.d.ts:171


interceptors

interceptors: Object

Type declaration

Name Type
request AxiosInterceptorManager<AxiosRequestConfig<any>>
response AxiosInterceptorManager<AxiosResponse<any, any>>

Inherited from

Axios.interceptors

Defined in

packages/medusa-js/node_modules/axios/index.d.ts:172

Methods

delete

delete<T, R, D>(url, config?): Promise<R>

Type parameters

Name Type
T any
R AxiosResponse<T, any>
D any

Parameters

Name Type
url string
config? AxiosRequestConfig<D>

Returns

Promise<R>

Inherited from

Axios.delete

Defined in

packages/medusa-js/node_modules/axios/index.d.ts:179


get

get<T, R, D>(url, config?): Promise<R>

Type parameters

Name Type
T any
R AxiosResponse<T, any>
D any

Parameters

Name Type
url string
config? AxiosRequestConfig<D>

Returns

Promise<R>

Inherited from

Axios.get

Defined in

packages/medusa-js/node_modules/axios/index.d.ts:178


getUri

getUri(config?): string

Parameters

Name Type
config? AxiosRequestConfig<any>

Returns

string

Inherited from

Axios.getUri

Defined in

packages/medusa-js/node_modules/axios/index.d.ts:176


head

head<T, R, D>(url, config?): Promise<R>

Type parameters

Name Type
T any
R AxiosResponse<T, any>
D any

Parameters

Name Type
url string
config? AxiosRequestConfig<D>

Returns

Promise<R>

Inherited from

Axios.head

Defined in

packages/medusa-js/node_modules/axios/index.d.ts:180


options

options<T, R, D>(url, config?): Promise<R>

Type parameters

Name Type
T any
R AxiosResponse<T, any>
D any

Parameters

Name Type
url string
config? AxiosRequestConfig<D>

Returns

Promise<R>

Inherited from

Axios.options

Defined in

packages/medusa-js/node_modules/axios/index.d.ts:181


patch

patch<T, R, D>(url, data?, config?): Promise<R>

Type parameters

Name Type
T any
R AxiosResponse<T, any>
D any

Parameters

Name Type
url string
data? D
config? AxiosRequestConfig<D>

Returns

Promise<R>

Inherited from

Axios.patch

Defined in

packages/medusa-js/node_modules/axios/index.d.ts:184


post

post<T, R, D>(url, data?, config?): Promise<R>

Type parameters

Name Type
T any
R AxiosResponse<T, any>
D any

Parameters

Name Type
url string
data? D
config? AxiosRequestConfig<D>

Returns

Promise<R>

Inherited from

Axios.post

Defined in

packages/medusa-js/node_modules/axios/index.d.ts:182


put

put<T, R, D>(url, data?, config?): Promise<R>

Type parameters

Name Type
T any
R AxiosResponse<T, any>
D any

Parameters

Name Type
url string
data? D
config? AxiosRequestConfig<D>

Returns

Promise<R>

Inherited from

Axios.put

Defined in

packages/medusa-js/node_modules/axios/index.d.ts:183


request

request<T, R, D>(config): Promise<R>

Type parameters

Name Type
T any
R AxiosResponse<T, any>
D any

Parameters

Name Type
config AxiosRequestConfig<D>

Returns

Promise<R>

Inherited from

Axios.request

Defined in

packages/medusa-js/node_modules/axios/index.d.ts:177