# 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

- Defined in node_modules/axios/index.d.ts:316

##### 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

### `Optional` adapter

adapter?: AxiosAdapterConfig | AxiosAdapterConfig []

- Defined in node_modules/axios/index.d.ts:330

### `Optional` allowAbsoluteUrls

allowAbsoluteUrls?: boolean

- Defined in node_modules/axios/index.d.ts:320

### `Optional` auth

auth?: AxiosBasicCredentials

- Defined in node_modules/axios/index.d.ts:331

### `Optional` baseURL

baseURL?: string

- Defined in node_modules/axios/index.d.ts:319

### `Optional` beforeRedirect

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

- Defined in node_modules/axios/index.d.ts:343

### `Optional` cancelToken

cancelToken?: CancelToken

- Defined in node_modules/axios/index.d.ts:349

### `Optional` data

data?: D

- Defined in node_modules/axios/index.d.ts:326

### `Optional` decompress

decompress?: boolean

- Defined in node_modules/axios/index.d.ts:350

### `Optional` env

env?: { FormData?: new (...args: any[]) => object }

- Defined in node_modules/axios/index.d.ts:354

### `Optional` family

family?: AddressFamily

- Defined in node_modules/axios/index.d.ts:358

### `Optional` fetchOptions

fetchOptions?: Record <string, any>

- Defined in node_modules/axios/index.d.ts:362

### `Optional` formSerializer

formSerializer?: FormSerializerOptions

- Defined in node_modules/axios/index.d.ts:357

### `Optional` headers

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 },
>

- Defined in node_modules/axios/index.d.ts:323

### `Optional` httpAgent

httpAgent?: any

- Defined in node_modules/axios/index.d.ts:346

### `Optional` httpsAgent

httpsAgent?: any

- Defined in node_modules/axios/index.d.ts:347

### `Optional` insecureHTTPParser

insecureHTTPParser?: boolean

- Defined in node_modules/axios/index.d.ts:353

### `Optional` lookup

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 ,
],
>
)

- Defined in node_modules/axios/index.d.ts:359

### `Optional` maxBodyLength

maxBodyLength?: number

- Defined in node_modules/axios/index.d.ts:340

### `Optional` maxContentLength

maxContentLength?: number

- Defined in node_modules/axios/index.d.ts:338

### `Optional` maxRate

maxRate?: number | [number, number]

- Defined in node_modules/axios/index.d.ts:342

### `Optional` maxRedirects

maxRedirects?: number

- Defined in node_modules/axios/index.d.ts:341

### `Optional` method

method?: string

- Defined in node_modules/axios/index.d.ts:318

### `Optional` onDownloadProgress

onDownloadProgress?: (progressEvent: AxiosProgressEvent ) => void

- Defined in node_modules/axios/index.d.ts:337

### `Optional` onUploadProgress

onUploadProgress?: (progressEvent: AxiosProgressEvent ) => void

- Defined in node_modules/axios/index.d.ts:336

### `Optional` params

params?: any

- Defined in node_modules/axios/index.d.ts:324

### `Optional` paramsSerializer

paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer

- Defined in node_modules/axios/index.d.ts:325

### `Optional` proxy

proxy?: false | AxiosProxyConfig

- Defined in node_modules/axios/index.d.ts:348

### `Optional` responseEncoding

responseEncoding?: string

- Defined in node_modules/axios/index.d.ts:333

### `Optional` responseType

responseType?: ResponseType

- Defined in node_modules/axios/index.d.ts:332

### `Optional` signal

signal?: GenericAbortSignal

- Defined in node_modules/axios/index.d.ts:352

### `Optional` socketPath

socketPath?: null | string

- Defined in node_modules/axios/index.d.ts:344

### `Optional` timeout

timeout?: number

- Defined in node_modules/axios/index.d.ts:327

### `Optional` timeoutErrorMessage

timeoutErrorMessage?: string

- Defined in node_modules/axios/index.d.ts:328

### `Optional` transformRequest

transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer []

- Defined in node_modules/axios/index.d.ts:321

### `Optional` transformResponse

transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer []

- Defined in node_modules/axios/index.d.ts:322

### `Optional` transitional

transitional?: TransitionalOptions

- Defined in node_modules/axios/index.d.ts:351

### `Optional` transport

transport?: any

- Defined in node_modules/axios/index.d.ts:345

### `Optional` url

url?: string

- Defined in node_modules/axios/index.d.ts:317

### `Optional` validateStatus

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

- Defined in node_modules/axios/index.d.ts:339

### `Optional` withCredentials

withCredentials?: boolean

- Defined in node_modules/axios/index.d.ts:329

### `Optional` withXSRFToken

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

- Defined in node_modules/axios/index.d.ts:361

### `Optional` xsrfCookieName

xsrfCookieName?: string

- Defined in node_modules/axios/index.d.ts:334

### `Optional` xsrfHeaderName

xsrfHeaderName?: string

- Defined in node_modules/axios/index.d.ts:335