Optionaladapter
adapter?: AxiosAdapterConfig | AxiosAdapterConfig[]
OptionalallowAbsoluteUrls
allowAbsoluteUrls?: boolean
OptionalallowedSocketPaths
allowedSocketPaths?: string | string[] | null
Optionalauth
auth?: AxiosBasicCredentials
OptionalbaseURL
baseURL?: string
OptionalbeforeRedirect
beforeRedirect?: ( options: Record<string, any>, responseDetails: { headers: Record<string, string>; statusCode: HttpStatusCode; }, requestDetails: { headers: Record<string, string>; method: string; url: string; },) => void
OptionalcancelToken
cancelToken?: CancelToken
Optionaldata
Optionaldecompress
decompress?: boolean
Optionalenv
Optionalfamily
family?: AddressFamily
OptionalfetchOptions
fetchOptions?: | Record<string, any> | Omit<RequestInit, "body" | "headers" | "method" | "signal">
formDataHeaderPolicy?: "legacy" | "content-only"
formSerializer?: FormSerializerOptions
headers?: | AxiosHeaders | Partial< RawAxiosHeaders & { Accept: AxiosHeaderValue; Authorization: AxiosHeaderValue; "Content-Encoding": AxiosHeaderValue; "Content-Length": AxiosHeaderValue; Location: 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; query: AxiosHeaders; unlink: AxiosHeaders; } & { common: AxiosHeaders }, >
Optionalhttp2Options
http2Options?: Record<string, any> & { sessionTimeout?: number }
OptionalhttpAgent
httpAgent?: any
OptionalhttpsAgent
httpsAgent?: any
OptionalhttpVersion
httpVersion?: 1 | 2
OptionalinsecureHTTPParser
insecureHTTPParser?: boolean
Optionallookup
lookup?: | (
( hostname: string, options: object, cb: ( err: Error | null, address: LookupAddress | LookupAddress[], family?: AddressFamily, ) => void, ) => void )
| (
( hostname: string, options: object, ) => Promise< | LookupAddress | [ address
: LookupAddressEntry | LookupAddressEntry[], family
?: AddressFamily, ], > )
OptionalmaxBodyLength
maxBodyLength?: number
OptionalmaxContentLength
maxContentLength?: number
OptionalmaxRate
maxRate?: number | [number, number]
OptionalmaxRedirects
maxRedirects?: number
Optionalmethod
method?: StringLiteralsOrString<Method>
OptionalonDownloadProgress
onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void
OptionalonUploadProgress
onUploadProgress?: (progressEvent: AxiosProgressEvent) => void
Optionalparams
params?: any
OptionalparamsSerializer
paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer
OptionalparseReviver
parseReviver?: (
this: any,
key: string,
value: any,
context?: { source?: string },
) => any
Optionalproxy
proxy?: false | AxiosProxyConfig
Optionalredact
redact?: string[]
OptionalresponseEncoding
responseEncoding?: StringLiteralsOrString<responseEncoding>
OptionalresponseType
responseType?: ResponseType
sensitiveHeaders?: string[]
Optionalsignal
signal?: GenericAbortSignal
OptionalsocketPath
socketPath?: string | null
Optionaltimeout
timeout?: number
OptionaltimeoutErrorMessage
timeoutErrorMessage?: string
transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[]
transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[]
Optionaltransitional
transitional?: TransitionalOptions
Optionaltransport
transport?: any
Optionalurl
url?: string
OptionalvalidateStatus
validateStatus?: ((status: number) => boolean) | null
OptionalwithCredentials
withCredentials?: boolean
OptionalwithXSRFToken
withXSRFToken?:
| boolean
| ((config: InternalAxiosRequestConfig) => boolean | undefined)
OptionalxsrfCookieName
xsrfCookieName?: string
xsrfHeaderName?: string
Axios Cache Interceptor request configuration. Use
falseto disable caching for a single request.