Optionaladapter
adapter?: AxiosAdapterConfig | AxiosAdapterConfig[]
Optionalauth
auth?: AxiosBasicCredentials
OptionalaxiosInstance
axiosInstance?: AxiosInstance
baseURL
baseURL: undefined | string
OptionalbeforeRedirect
beforeRedirect?: (
options: Record<string, any>,
responseDetails: {
headers: Record<string, string>;
statusCode: HttpStatusCode;
},
) => void
OptionalcancelToken
cancelToken?: CancelToken
Optionaldecompress
decompress?: boolean
Optionalenv
env?: { FormData?: new (...args: any[]) => object }
Optionalfamily
family?: AddressFamily
OptionalfetchOptions
fetchOptions?: Record<string, any>
OptionalformSerializer
formSerializer?: FormSerializerOptions
Optionalheaders
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 },
>
OptionalhttpAgent
httpAgent?: any
OptionalhttpsAgent
httpsAgent?: any
OptionalinsecureHTTPParser
insecureHTTPParser?: boolean
Optionallookup
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,
],
>
OptionalmaxBodyLength
maxBodyLength?: number
OptionalmaxContentLength
maxContentLength?: number
OptionalmaxRate
maxRate?: number | [number, number]
OptionalmaxRedirects
maxRedirects?: number
Optionalmethod
method?: string
OptionalonDownloadProgress
onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void
OptionalonUploadProgress
onUploadProgress?: (progressEvent: AxiosProgressEvent) => void
Optionalparams
params?: any
OptionalparamsSerializer
paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer
Optionalproxy
proxy?: false | AxiosProxyConfig
OptionalresponseEncoding
responseEncoding?: string
OptionalresponseType
responseType?: ResponseType
Optionalsignal
signal?: GenericAbortSignal
OptionalsocketPath
socketPath?: null | string
Optionaltimeout
timeout?: number
OptionaltimeoutErrorMessage
timeoutErrorMessage?: string
OptionaltransformRequest
transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[]
OptionaltransformResponse
transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[]
Optionaltransitional
transitional?: TransitionalOptions
Optionaltransport
transport?: any
OptionalvalidateStatus
validateStatus?: null | (status: number) => boolean
OptionalwithCredentials
withCredentials?: boolean
OptionalwithXSRFToken
withXSRFToken?:
| boolean
| (config: InternalAxiosRequestConfig) => undefined | boolean
OptionalxsrfCookieName
xsrfCookieName?: string
OptionalxsrfHeaderName
xsrfHeaderName?: string