• Backend Script API
• <internal>
• AxiosRequestConfig

Interface AxiosRequestConfig<D>

interface AxiosRequestConfig<D = any> {
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?: { FormData?: new (...args: any[]) => object };
family?: AddressFamily;
fetchOptions?: Record<string, any>;
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 },
>;
httpAgent?: any;
httpsAgent?: any;
insecureHTTPParser?: boolean;
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,
],
>
);
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;
proxy?: false | AxiosProxyConfig;
responseEncoding?: string;
responseType?: ResponseType;
signal?: GenericAbortSignal;
socketPath?: null | string;
timeout?: number;
timeoutErrorMessage?: string;
transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
transitional?: TransitionalOptions;
transport?: any;
url?: string;
validateStatus?: null | ((status: number) => boolean);
withCredentials?: boolean;
withXSRFToken?:
| boolean
| ((config: InternalAxiosRequestConfig) => undefined | boolean);
xsrfCookieName?: string;
xsrfHeaderName?: string;
}

Type Parameters

• D = any

Hierarchy (View Summary)

• AxiosRequestConfig
  • InternalAxiosRequestConfig

Index

Properties

adapter?allowAbsoluteUrls?auth?baseURL?beforeRedirect?cancelToken?data?decompress?env?family?fetchOptions?formSerializer?headers?httpAgent?httpsAgent?insecureHTTPParser?lookup?maxBodyLength?maxContentLength?maxRate?maxRedirects?method?onDownloadProgress?onUploadProgress?params?paramsSerializer?proxy?responseEncoding?responseType?signal?socketPath?timeout?timeoutErrorMessage?transformRequest?transformResponse?transitional?transport?url?validateStatus?withCredentials?withXSRFToken?xsrfCookieName?xsrfHeaderName?

Properties

Optionaladapter

adapter?: AxiosAdapterConfig | AxiosAdapterConfig[]

OptionalallowAbsoluteUrls

allowAbsoluteUrls?: boolean

Optionalauth

auth?: AxiosBasicCredentials

OptionalbaseURL

baseURL?: string

OptionalbeforeRedirect

beforeRedirect?: (
options: Record<string, any>,
responseDetails: {
headers: Record<string, string>;
statusCode: HttpStatusCode;
},
) => void

OptionalcancelToken

cancelToken?: CancelToken

Optionaldata

data?: D

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

Optionalurl

url?: string

OptionalvalidateStatus

validateStatus?: null | ((status: number) => boolean)

OptionalwithCredentials

withCredentials?: boolean

OptionalwithXSRFToken

withXSRFToken?:
| boolean
| ((config: InternalAxiosRequestConfig) => undefined | boolean)

OptionalxsrfCookieName

xsrfCookieName?: string

OptionalxsrfHeaderName

xsrfHeaderName?: string

Settings

Member Visibility

• Protected
• Inherited
• External

ThemeOSLightDark

On This Page

Properties adapterallowAbsoluteUrlsauthbaseURLbeforeRedirectcancelTokendatadecompressenvfamilyfetchOptionsformSerializerheadershttpAgenthttpsAgentinsecureHTTPParserlookupmaxBodyLengthmaxContentLengthmaxRatemaxRedirectsmethodonDownloadProgressonUploadProgressparamsparamsSerializerproxyresponseEncodingresponseTypesignalsocketPathtimeouttimeoutErrorMessagetransformRequesttransformResponsetransitionaltransporturlvalidateStatuswithCredentialswithXSRFTokenxsrfCookieNamexsrfHeaderName