Optional
adapter
adapter?: AxiosAdapterConfig | AxiosAdapterConfig[]
Optional
allowAbsoluteUrls
allowAbsoluteUrls?: boolean
Optional
auth
auth?: AxiosBasicCredentials
Optional
baseURL
baseURL?: string
Optional
beforeRedirect
beforeRedirect?: ( options: Record<string, any>, responseDetails: { headers: Record<string, string>; statusCode: HttpStatusCode; },) => void Optional
cancelToken
cancelToken?: CancelToken
Optional
decompress
decompress?: boolean
Optional
env
env?: { FormData?: new (...args: any[]) => object }
Optional
family
family?: AddressFamily
Optional
fetchOptions
fetchOptions?: | Record<string, any> | Omit<RequestInit, "body" | "headers" | "method" | "signal"> formSerializer?: FormSerializerOptions
headers?: | AxiosHeaders | Partial< RawAxiosHeaders & { Accept: AxiosHeaderValue; Authorization: AxiosHeaderValue; "Content-Encoding": AxiosHeaderValue; "Content-Length": AxiosHeaderValue; "User-Agent": AxiosHeaderValue; } & { "Content-Type": ContentType }, > & Partial< { delete: AxiosHeaders; get: AxiosHeaders; head: AxiosHeaders; link: AxiosHeaders; options: AxiosHeaders; patch: AxiosHeaders; post: AxiosHeaders; purge: AxiosHeaders; put: AxiosHeaders; unlink: AxiosHeaders; } & { common: AxiosHeaders }, > Optional
httpAgent
httpAgent?: any
Optional
httpsAgent
httpsAgent?: any
Optional
id
id?: string
Optional
insecureHTTPParser
insecureHTTPParser?: boolean
Optional
lookup
lookup?: | (
( hostname: string, options: object, cb: ( err: null | Error, address: LookupAddress | LookupAddress[], family?: AddressFamily, ) => void, ) => void )
| (
( hostname: string, options: object, ) => Promise< | LookupAddress | [ address
: LookupAddressEntry | LookupAddressEntry[], family
?: AddressFamily, ], > )
Optional
maxBodyLength
maxBodyLength?: number
Optional
maxContentLength
maxContentLength?: number
Optional
maxRate
maxRate?: number | [number, number]
Optional
maxRedirects
maxRedirects?: number
Optional
method
method?: string
Optional
onDownloadProgress
onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void
Optional
onUploadProgress
onUploadProgress?: (progressEvent: AxiosProgressEvent) => void
Optional
params
params?: any
Optional
paramsSerializer
paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer
Optional
proxy
proxy?: false | AxiosProxyConfig
Optional
responseEncoding
responseEncoding?: string
Optional
responseType
responseType?: ResponseType
Optional
signal
signal?: GenericAbortSignal
Optional
socketPath
socketPath?: null | string
Optional
timeout
timeout?: number
Optional
timeoutErrorMessage
timeoutErrorMessage?: string
transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[]
transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[]
Optional
transitional
transitional?: TransitionalOptions
Optional
transport
transport?: any
Optional
validateStatus
validateStatus?: null | ((status: number) => boolean)
Optional
withCredentials
withCredentials?: boolean
Optional
withXSRFToken
withXSRFToken?:
| boolean
| ((config: InternalAxiosRequestConfig) => undefined | boolean)
Optional
xsrfCookieName
xsrfCookieName?: string
Options that can be overridden per request