Interface AxiosRequestConfig<D>

interface AxiosRequestConfig<D> {
    adapter?: AxiosAdapter;
    auth?: AxiosBasicCredentials;
    baseURL?: string;
    beforeRedirect?: ((options, responseDetails) => void);
    cancelToken?: CancelToken;
    data?: D;
    decompress?: boolean;
    env?: {
        FormData?: (new (...args) => object);
    };
    formSerializer?: FormSerializerOptions;
    headers?: Partial<AxiosHeaders & MethodsHeaders & CommonHeaders>;
    httpAgent?: any;
    httpsAgent?: any;
    insecureHTTPParser?: boolean;
    maxBodyLength?: number;
    maxContentLength?: number;
    maxRedirects?: number;
    method?: string;
    onDownloadProgress?: ((progressEvent) => void);
    onUploadProgress?: ((progressEvent) => 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;
    url?: string;
    validateStatus?: null | ((status) => boolean);
    withCredentials?: boolean;
    withXSRFToken?: boolean | ((config) => undefined | boolean);
    xsrfCookieName?: string;
    xsrfHeaderName?: string;
}

Type Parameters

  • D = any

Properties

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

Properties

Optional adapter

adapter?: AxiosAdapter

Optional auth

auth?: AxiosBasicCredentials

Optional baseURL

baseURL?: string

Optional beforeRedirect

beforeRedirect?: ((options, responseDetails) => void)

Type declaration

    • (options, responseDetails): void

    • Parameters

      • options: Record<string, any>
      • responseDetails: {
            headers: Record<string, string>;
        }
        • headers: Record<string, string>

      Returns void

Optional cancelToken

cancelToken?: CancelToken

Optional data

data?: D

Optional decompress

decompress?: boolean

Optional env

env?: {
    FormData?: (new (...args) => object);
}

Type declaration

  • Optional FormData?: (new (...args) => object)
      • new (...args): object

      • Parameters

        • Rest ...args: any[]

        Returns object

Optional formSerializer

formSerializer?: FormSerializerOptions

Optional headers

headers?: Partial<AxiosHeaders & MethodsHeaders & CommonHeaders>

Optional httpAgent

httpAgent?: any

Optional httpsAgent

httpsAgent?: any

Optional insecureHTTPParser

insecureHTTPParser?: boolean

Optional maxBodyLength

maxBodyLength?: number

Optional maxContentLength

maxContentLength?: number

Optional maxRedirects

maxRedirects?: number

Optional method

method?: string

Optional onDownloadProgress

onDownloadProgress?: ((progressEvent) => void)

Type declaration

    • (progressEvent): void

    • Parameters

      Returns void

Optional onUploadProgress

onUploadProgress?: ((progressEvent) => void)

Type declaration

    • (progressEvent): void

    • Parameters

      Returns void

Optional params

params?: any

Optional paramsSerializer

paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer

Optional proxy

proxy?: false | AxiosProxyConfig

Optional responseEncoding

responseEncoding?: string

Optional responseType

responseType?: ResponseType

Optional signal

signal?: GenericAbortSignal

Optional socketPath

socketPath?: null | string

Optional timeout

timeout?: number

Optional timeoutErrorMessage

timeoutErrorMessage?: string

Optional transformRequest

transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[]

Optional transformResponse

transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[]

Optional transitional

transitional?: TransitionalOptions

Optional url

url?: string

Optional validateStatus

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

Type declaration

    • (status): boolean

    • Parameters

      • status: number

      Returns boolean

Optional withCredentials

withCredentials?: boolean

Optional withXSRFToken

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

Type declaration

    • (config): undefined | boolean

    • Parameters

      Returns undefined | boolean

Optional xsrfCookieName

xsrfCookieName?: string

Optional xsrfHeaderName

xsrfHeaderName?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc