Properties
Optional adapter
adapter?: AxiosAdapter
Optional auth
auth?: AxiosBasicCredentials
Optional baseURL
baseURL?: string
Optional beforeRedirect
beforeRedirect?: ((options, responseDetails) => void)
Type declaration
-
- (options, responseDetails): void
-
Parameters
-
options: Record<string, any>
-
responseDetails: {
headers: Record<string, string>;
}
-
headers: Record<string, string>
Returns void
Optional cancelToken
cancelToken?: CancelToken
Optional decompress
decompress?: boolean
Optional env
env?: {
FormData?: (new (...args) => object);
}
Type declaration
-
Optional FormData?: (new (...args) => object)
-
- new (...args): object
-
Returns object
Optional headers
headers?: AxiosRequestHeaders
Optional httpAgent
httpAgent?: any
Optional httpsAgent
httpsAgent?: any
Optional insecureHTTPParser
insecureHTTPParser?: boolean
Optional mapResponse
mapResponse?: ((config) => any)
Type declaration
-
- (config): any
-
Returns any
Optional maxBodyLength
maxBodyLength?: number
Optional maxContentLength
maxContentLength?: number
Optional maxRedirects
maxRedirects?: number
Optional method
method?: string
Optional onDownloadProgress
onDownloadProgress?: ((progressEvent) => void)
Type declaration
-
- (progressEvent): void
-
Returns void
Optional onUploadProgress
onUploadProgress?: ((progressEvent) => void)
Type declaration
-
- (progressEvent): void
-
Returns void
Optional params
params?: any
Optional paramsSerializer
paramsSerializer?: ((params) => string)
Type declaration
-
- (params): string
-
Returns string
Optional proxy
proxy?: false | AxiosProxyConfig
Optional responseEncoding
responseEncoding?: string
Optional responseType
responseType?: ResponseType
Optional retries
retries?: number
Optional retryInterval
retryInterval?: number
Optional shouldRetry
shouldRetry?: ((response) => boolean)
Type declaration
-
- (response): boolean
-
Parameters
-
response: AxiosResponse<any, any>
Returns boolean
Optional signal
signal?: AbortSignal
Optional socketPath
socketPath?: null | string
Optional timeout
timeout?: number
Optional timeoutErrorMessage
timeoutErrorMessage?: string
Optional transformRequest
transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[]
Optional transformResponse
transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[]
Optional transitional
transitional?: TransitionalOptions
Optional validateStatus
validateStatus?: null | ((status) => boolean)
Type declaration
-
- (status): boolean
-
Returns boolean
Optional withCredentials
withCredentials?: boolean
Optional xsrfCookieName
xsrfCookieName?: string
Optional xsrfHeaderName
xsrfHeaderName?: string
A function that maps http response body to corresponding config object