Optionaladapter
adapter ?: AxiosAdapterConfig | AxiosAdapterConfig []
Optionalallow Absolute Urls
allowAbsoluteUrls ?: boolean
Optionalallowed Socket Paths
allowedSocketPaths ?: string | string [] | null
Optionalauth
auth ?: AxiosBasicCredentials
Optionalbase URL
baseURL ?: string
Optionalbefore Redirect
beforeRedirect ?: ( options : Record < string , any > , responseDetails : { headers : Record < string , string > ; statusCode : HttpStatusCode ; } , requestDetails : { headers : Record < string , string > ; method : string ; url : string ; } , ) => void
Optionalcancel Token
cancelToken ?: CancelToken
Optionaldecompress
decompress ?: boolean
Optionalfamily
family ?: AddressFamily
Optionalfetch Options
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 } , >
Optionalhttp2 Options
http2Options ?: Record < string , any > & { sessionTimeout ?: number }
Optionalhttp Agent
httpAgent ?: any
Optionalhttps Agent
httpsAgent ?: any
Optionalhttp Version
httpVersion ?: 1 | 2
Optionalid
id ?: string
Defined in node_modules/axios-cache-interceptor/dist/index.d.mts:711
Optionalinsecure HTTP Parser
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 , ] , > )
Optionalmax Body Length
maxBodyLength ?: number
Optionalmax Content Length
maxContentLength ?: number
Optionalmax Rate
maxRate ?: number | [ number , number ]
Optionalmax Redirects
maxRedirects ?: number
Optionalmethod
method ?: StringLiteralsOrString < Method >
Optionalon Download Progress
onDownloadProgress ?: ( progressEvent : AxiosProgressEvent ) => void
Optionalon Upload Progress
onUploadProgress ?: ( progressEvent : AxiosProgressEvent ) => void
Optionalparams
params ?: any
Optionalparams Serializer
paramsSerializer ?: ParamsSerializerOptions | CustomParamsSerializer
Optionalparse Reviver
parseReviver ?: ( this : any , key : string , value : any , context ?: { source ?: string } , ) => any
Optionalproxy
proxy ?: false | AxiosProxyConfig
Optionalredact
redact ?: string []
Optionalresponse Encoding
responseEncoding ?: StringLiteralsOrString < responseEncoding >
Optionalresponse Type
responseType ?: ResponseType
sensitiveHeaders ?: string []
Optionalsignal
signal ?: GenericAbortSignal
Optionalsocket Path
socketPath ?: string | null
Optionaltimeout
timeout ?: number
Optionaltimeout Error Message
timeoutErrorMessage ?: string
transformRequest ?: AxiosRequestTransformer | AxiosRequestTransformer []
transformResponse ?: AxiosResponseTransformer | AxiosResponseTransformer []
Optionaltransitional
transitional ?: TransitionalOptions
Optionaltransport
transport ?: any
Optionalvalidate Status
validateStatus ?: (( status : number ) => boolean ) | null
Optionalwith Credentials
withCredentials ?: boolean
Optionalwith XSRF Token
withXSRFToken ?: | boolean | (( config : InternalAxiosRequestConfig ) => boolean | undefined )
Optionalxsrf Cookie Name
xsrfCookieName ?: string
Options that can be overridden per request