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
Optionaldecompress
decompress?: boolean
Optionalenv
env?: {
fetch?: (
input: string | URL | Request,
init?: RequestInit,
) => Promise<Response>;
FormData?: new (...args: any[]) => object;
Request?: new (
input: string | URL | Request,
init?: RequestInit,
) => Request;
Response?: new (
body?:
| string
| ArrayBuffer
| Blob
| FormData
| URLSearchParams
| ArrayBufferView<ArrayBufferLike>
| null,
init?: ResponseInit,
) => Response;
}
Optionalfamily
family?: AddressFamily
OptionalfetchOptions
fetchOptions?:
| Record<string, any>
| Omit<RequestInit, "body" | "headers" | "method" | "signal">
formDataHeaderPolicy?: "legacy" | "content-only"
formSerializer?: FormSerializerOptions
headers?: {
"x-myinterview-key": string;
"x-myinterview-signed": string;
"x-myinterview-timestamp": string;
}
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
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
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
OptionalvalidateStatus
validateStatus?: ((status: number) => boolean) | null
OptionalwithCredentials
withCredentials?: boolean
OptionalwithXSRFToken
withXSRFToken?:
| boolean
| ((config: InternalAxiosRequestConfig) => boolean | undefined)
OptionalxsrfCookieName
xsrfCookieName?: string