Interface CreateAxiosDefaults<D>

interface CreateAxiosDefaults<D> {
    adapter?: AxiosAdapterConfig | AxiosAdapterConfig[];
    allowAbsoluteUrls?: boolean;
    allowedSocketPaths?: string | string[];
    auth?: AxiosBasicCredentials;
    axios-retry?: IAxiosRetryConfigExtended;
    baseURL?: string;
    beforeRedirect?: ((options, responseDetails, requestDetails) => void);
    cancelToken?: CancelToken;
    data?: D;
    decompress?: boolean;
    env?: {
        FormData?: (new (...args) => object);
        Request?: (new (input, init?) => Request);
        Response?: (new (body?, init?) => Response);
        fetch?: ((input, init?) => Promise<Response>);
    };
    family?: AddressFamily;
    fetchOptions?: Record<string, any> | Omit<RequestInit, "headers" | "method" | "signal" | "body">;
    formDataHeaderPolicy?: "legacy" | "content-only";
    formSerializer?: FormSerializerOptions;
    headers?: AxiosHeaders | Partial<RawAxiosHeaders & {
        Accept: AxiosHeaderValue;
        Authorization: AxiosHeaderValue;
        Content-Encoding: AxiosHeaderValue;
        Content-Length: AxiosHeaderValue;
        Location: AxiosHeaderValue;
        User-Agent: AxiosHeaderValue;
    } & {
        Content-Type: ContentType;
    }> | Partial<HeadersDefaults>;
    http2Options?: Record<string, any> & {
        sessionTimeout?: number;
    };
    httpAgent?: any;
    httpVersion?: 1 | 2;
    httpsAgent?: any;
    insecureHTTPParser?: boolean;
    lookup?: ((hostname, options, cb) => void) | ((hostname, options) => Promise<LookupAddress | [address: LookupAddressEntry | LookupAddressEntry[], family?: AddressFamily]>);
    maxBodyLength?: number;
    maxContentLength?: number;
    maxRate?: number | [number, number];
    maxRedirects?: number;
    method?: StringLiteralsOrString<Method>;
    onDownloadProgress?: ((progressEvent) => void);
    onUploadProgress?: ((progressEvent) => void);
    params?: any;
    paramsSerializer?: CustomParamsSerializer | ParamsSerializerOptions;
    parseReviver?: ((this, key, value, context?) => any);
    proxy?: false | AxiosProxyConfig;
    redact?: string[];
    responseEncoding?: StringLiteralsOrString<responseEncoding>;
    responseType?: ResponseType;
    sensitiveHeaders?: string[];
    signal?: GenericAbortSignal;
    socketPath?: string;
    timeout?: number;
    timeoutErrorMessage?: string;
    transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
    transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
    transitional?: TransitionalOptions;
    transport?: any;
    url?: string;
    validateStatus?: ((status) => boolean);
    withCredentials?: boolean;
    withXSRFToken?: boolean | ((config) => boolean);
    xsrfCookieName?: string;
    xsrfHeaderName?: string;
}

Type Parameters

  • D = any

Hierarchy

Properties

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

Properties

Optional adapter

adapter?: AxiosAdapterConfig | AxiosAdapterConfig[]

Optional allowAbsoluteUrls

allowAbsoluteUrls?: boolean

Optional allowedSocketPaths

allowedSocketPaths?: string | string[]

Optional auth

auth?: AxiosBasicCredentials

Optional axios-retry

axios-retry?: IAxiosRetryConfigExtended

Optional baseURL

baseURL?: string

Optional beforeRedirect

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

Type declaration

    • (options, responseDetails, requestDetails): void

    • Parameters

      • options: Record<string, any>
      • responseDetails: {
            headers: Record<string, string>;
            statusCode: HttpStatusCode;
        }
      • requestDetails: {
            headers: Record<string, string>;
            method: string;
            url: string;
        }
        • headers: Record<string, string>
        • method: string
        • url: string

      Returns void

Optional cancelToken

cancelToken?: CancelToken

Optional data

data?: D

Optional decompress

decompress?: boolean

Optional env

env?: {
    FormData?: (new (...args) => object);
    Request?: (new (input, init?) => Request);
    Response?: (new (body?, init?) => Response);
    fetch?: ((input, init?) => Promise<Response>);
}

Type declaration

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

      • Parameters

        • Rest ...args: any[]

        Returns object

  • Optional Request?: (new (input, init?) => Request)
      • new (input, init?): Request

      • Parameters

        • input: string | URL | Request
        • Optional init: RequestInit

        Returns Request

  • Optional Response?: (new (body?, init?) => Response)
      • new (body?, init?): Response

      • Parameters

        • Optional body: string | ArrayBuffer | ArrayBufferView | Blob | FormData | URLSearchParams
        • Optional init: ResponseInit

        Returns Response

  • Optional fetch?: ((input, init?) => Promise<Response>)
      • (input, init?): Promise<Response>

      • Parameters

        • input: string | URL | Request
        • Optional init: RequestInit

        Returns Promise<Response>

Optional family

family?: AddressFamily

Optional fetchOptions

fetchOptions?: Record<string, any> | Omit<RequestInit, "headers" | "method" | "signal" | "body">

Optional formDataHeaderPolicy

formDataHeaderPolicy?: "legacy" | "content-only"

Optional formSerializer

formSerializer?: FormSerializerOptions

Optional headers

headers?: AxiosHeaders | Partial<RawAxiosHeaders & {
    Accept: AxiosHeaderValue;
    Authorization: AxiosHeaderValue;
    Content-Encoding: AxiosHeaderValue;
    Content-Length: AxiosHeaderValue;
    Location: AxiosHeaderValue;
    User-Agent: AxiosHeaderValue;
} & {
    Content-Type: ContentType;
}> | Partial<HeadersDefaults>

Optional http2Options

http2Options?: Record<string, any> & {
    sessionTimeout?: number;
}

Type declaration

  • Optional sessionTimeout?: number

Optional httpAgent

httpAgent?: any

Optional httpVersion

httpVersion?: 1 | 2

Optional httpsAgent

httpsAgent?: any

Optional insecureHTTPParser

insecureHTTPParser?: boolean

Optional lookup

lookup?: ((hostname, options, cb) => void) | ((hostname, options) => Promise<LookupAddress | [address: LookupAddressEntry | LookupAddressEntry[], family?: AddressFamily]>)

Type declaration

    • (hostname, options, cb): void

    • Parameters

      • hostname: string
      • options: object
      • cb: ((err, address, family?) => void)

      Returns void

Type declaration

Optional maxBodyLength

maxBodyLength?: number

Optional maxContentLength

maxContentLength?: number

Optional maxRate

maxRate?: number | [number, number]

Optional maxRedirects

maxRedirects?: number

Optional method

method?: StringLiteralsOrString<Method>

Optional onDownloadProgress

onDownloadProgress?: ((progressEvent) => void)

Type declaration

Optional onUploadProgress

onUploadProgress?: ((progressEvent) => void)

Type declaration

Optional params

params?: any

Optional paramsSerializer

paramsSerializer?: CustomParamsSerializer | ParamsSerializerOptions

Optional parseReviver

parseReviver?: ((this, key, value, context?) => any)

Type declaration

    • (this, key, value, context?): any

    • Parameters

      • this: any
      • key: string
      • value: any
      • Optional context: {
            source?: string;
        }
        • Optional source?: string

      Returns any

Optional proxy

proxy?: false | AxiosProxyConfig

Optional redact

redact?: string[]

Optional responseEncoding

responseEncoding?: StringLiteralsOrString<responseEncoding>

Optional responseType

responseType?: ResponseType

Optional sensitiveHeaders

sensitiveHeaders?: string[]

Optional signal

signal?: GenericAbortSignal

Optional socketPath

socketPath?: string

Optional timeout

timeout?: number

Optional timeoutErrorMessage

timeoutErrorMessage?: string

Optional transformRequest

transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[]

Optional transformResponse

transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[]

Optional transitional

transitional?: TransitionalOptions

Optional transport

transport?: any

Optional url

url?: string

Optional validateStatus

validateStatus?: ((status) => boolean)

Type declaration

    • (status): boolean

    • Parameters

      • status: number

      Returns boolean

Optional withCredentials

withCredentials?: boolean

Optional withXSRFToken

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

Type declaration

Optional xsrfCookieName

xsrfCookieName?: string

Optional xsrfHeaderName

xsrfHeaderName?: string

Settings

Member Visibility

Theme

On This Page

adapterallowAbsoluteUrlsallowedSocketPathsauthaxios-retrybaseURLbeforeRedirectcancelTokendatadecompressenvfamilyfetchOptionsformDataHeaderPolicyformSerializerheadershttp2OptionshttpAgenthttpVersionhttpsAgentinsecureHTTPParserlookupmaxBodyLengthmaxContentLengthmaxRatemaxRedirectsmethodonDownloadProgressonUploadProgressparamsparamsSerializerparseReviverproxyredactresponseEncodingresponseTypesensitiveHeaderssignalsocketPathtimeouttimeoutErrorMessagetransformRequesttransformResponsetransitionaltransporturlvalidateStatuswithCredentialswithXSRFTokenxsrfCookieNamexsrfHeaderName