Skip to content

Interface: AxiosRequestConfig<D>

Type Parameters

Type ParameterDefault type
Dany

Properties

PropertyType
adapter?AxiosAdapterConfig | AxiosAdapterConfig[]
allowAbsoluteUrls?boolean
auth?AxiosBasicCredentials
baseURL?string
beforeRedirect?(options: Record<string, any>, responseDetails: { headers: Record<string, string>; statusCode: HttpStatusCode; }) => void
cancelToken?CancelToken
data?D
decompress?boolean
env?{ fetch?: (input: string | URL | Request, init?: RequestInit) => Promise<Response>; FormData?: (...args: any[]) => object; Request?: (input: string | URL | Request, init?: RequestInit) => Request; Response?: (body?: | string | ArrayBuffer | Blob | FormData | URLSearchParams | ArrayBufferView<ArrayBufferLike> | null, init?: ResponseInit) => Response; }
env.fetch?(input: string | URL | Request, init?: RequestInit) => Promise<Response>
env.FormData?(...args: any[]) => object
env.Request?(input: string | URL | Request, init?: RequestInit) => Request
env.Response?(body?: | string | ArrayBuffer | Blob | FormData | URLSearchParams | ArrayBufferView<ArrayBufferLike> | null, init?: ResponseInit) => Response
family?AddressFamily
fetchOptions?| Record<string, any> | Omit<RequestInit, "body" | "method" | "headers" | "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; }>
http2Options?Record<string, any> & { sessionTimeout?: number; }
httpAgent?any
httpsAgent?any
httpVersion?1 | 2
insecureHTTPParser?boolean
lookup?| (hostname: string, options: object, cb: (err: Error | null, address: LookupAddress | LookupAddress[], family?: AddressFamily) => void) => void | (hostname: string, options: object) => Promise< | LookupAddress | [LookupAddressEntry | LookupAddressEntry[], AddressFamily]>
maxBodyLength?number
maxContentLength?number
maxRate?number | [number, number]
maxRedirects?number
method?string
onDownloadProgress?(progressEvent: AxiosProgressEvent) => void
onUploadProgress?(progressEvent: AxiosProgressEvent) => void
params?any
paramsSerializer?ParamsSerializerOptions | CustomParamsSerializer
parseReviver?(this: any, key: string, value: any) => any
proxy?false | AxiosProxyConfig
responseEncoding?string
responseType?ResponseType
signal?GenericAbortSignal
socketPath?string | null
timeout?number
timeoutErrorMessage?string
transformRequest?AxiosRequestTransformer | AxiosRequestTransformer[]
transformResponse?AxiosResponseTransformer | AxiosResponseTransformer[]
transitional?TransitionalOptions
transport?any
url?string
validateStatus?(status: number) => boolean | null
withCredentials?boolean
withXSRFToken?| boolean | (config: InternalAxiosRequestConfig) => boolean | undefined
xsrfCookieName?string
xsrfHeaderName?string