Files
medusa-store/docs/content/references/js-client/interfaces/internal.AxiosRequestConfig.md
Shahed Nasser 3b28f46705 docs: added reference for JS Client (#1629)
* added reference for JS Client

* added reference for JS Client

* added reference for JS Client
2022-07-08 18:21:46 +03:00

5.6 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Interface: AxiosRequestConfig<D>

internal.AxiosRequestConfig

Type parameters

Name Type
D any

Properties

adapter

Optional adapter: AxiosAdapter

Defined in

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


auth

Optional auth: AxiosBasicCredentials

Defined in

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


baseURL

Optional baseURL: string

Defined in

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


cancelToken

Optional cancelToken: CancelToken

Defined in

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


data

Optional data: D

Defined in

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


decompress

Optional decompress: boolean

Defined in

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


headers

Optional headers: AxiosRequestHeaders

Defined in

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


httpAgent

Optional httpAgent: any

Defined in

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


httpsAgent

Optional httpsAgent: any

Defined in

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


insecureHTTPParser

Optional insecureHTTPParser: boolean

Defined in

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


maxBodyLength

Optional maxBodyLength: number

Defined in

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


maxContentLength

Optional maxContentLength: number

Defined in

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


maxRedirects

Optional maxRedirects: number

Defined in

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


method

Optional method: Method

Defined in

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


params

Optional params: any

Defined in

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


proxy

Optional proxy: false | AxiosProxyConfig

Defined in

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


raxConfig

Optional raxConfig: RetryConfig

Defined in

packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:89


responseType

Optional responseType: ResponseType

Defined in

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


signal

Optional signal: AbortSignal

Defined in

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


socketPath

Optional socketPath: null | string

Defined in

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


timeout

Optional timeout: number

Defined in

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


timeoutErrorMessage

Optional timeoutErrorMessage: string

Defined in

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


transformRequest

Optional transformRequest: AxiosRequestTransformer | AxiosRequestTransformer[]

Defined in

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


transformResponse

Optional transformResponse: AxiosResponseTransformer | AxiosResponseTransformer[]

Defined in

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


transitional

Optional transitional: TransitionalOptions

Defined in

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


url

Optional url: string

Defined in

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


validateStatus

Optional validateStatus: null | (status: number) => boolean

Defined in

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


withCredentials

Optional withCredentials: boolean

Defined in

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


xsrfCookieName

Optional xsrfCookieName: string

Defined in

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


xsrfHeaderName

Optional xsrfHeaderName: string

Defined in

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

Methods

onDownloadProgress

Optional onDownloadProgress(progressEvent): void

Parameters

Name Type
progressEvent any

Returns

void

Defined in

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


onUploadProgress

Optional onUploadProgress(progressEvent): void

Parameters

Name Type
progressEvent any

Returns

void

Defined in

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


paramsSerializer

Optional paramsSerializer(params): string

Parameters

Name Type
params any

Returns

string

Defined in

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