Interface AxiosStatic

interface AxiosStatic {
    Axios: typeof Axios;
    AxiosError: typeof AxiosError;
    AxiosHeaders: typeof AxiosHeaders;
    Cancel: CancelStatic;
    CancelToken: CancelTokenStatic;
    CanceledError: typeof CanceledError;
    HttpStatusCode: typeof HttpStatusCode;
    VERSION: string;
    all: (<T>(values) => Promise<T[]>);
    defaults: Omit<AxiosDefaults<any>, "headers"> & {
        headers: HeadersDefaults & {
            [key: string]: AxiosHeaderValue;
        };
    };
    formToJSON: ((form) => object);
    getAdapter: ((adapters) => AxiosAdapter);
    interceptors: {
        request: AxiosInterceptorManager<InternalAxiosRequestConfig<any>>;
        response: AxiosInterceptorManager<AxiosResponse<any, any, {}>>;
    };
    isAxiosError: (<T, D>(payload) => payload is AxiosError<T, D>);
    isCancel: (<T>(value) => value is CanceledError<T>);
    mergeConfig: (<D>(config1, config2) => AxiosRequestConfig<D>);
    spread: (<T, R>(callback) => ((array) => R));
    toFormData: ((sourceObj, targetFormData?, options?) => GenericFormData);
    create(config?): AxiosInstance;
    delete<T, R, D>(url, config?): Promise<R>;
    get<T, R, D>(url, config?): Promise<R>;
    getUri(config?): string;
    head<T, R, D>(url, config?): Promise<R>;
    options<T, R, D>(url, config?): Promise<R>;
    patch<T, R, D>(url, data?, config?): Promise<R>;
    patchForm<T, R, D>(url, data?, config?): Promise<R>;
    post<T, R, D>(url, data?, config?): Promise<R>;
    postForm<T, R, D>(url, data?, config?): Promise<R>;
    put<T, R, D>(url, data?, config?): Promise<R>;
    putForm<T, R, D>(url, data?, config?): Promise<R>;
    request<T, R, D>(config): Promise<R>;
    <T, R, D>(config): Promise<R>;
    <T, R, D>(url, config?): Promise<R>;
}

Hierarchy (view full)

  • AxiosStatic<T, R, D>(config): Promise<R>

  • Type Parameters

    Parameters

    Returns Promise<R>

  • AxiosStatic<T, R, D>(url, config?): Promise<R>

  • Type Parameters

    Parameters

    Returns Promise<R>

Properties

Axios AxiosError AxiosHeaders Cancel CancelToken CanceledError HttpStatusCode VERSION all defaults formToJSON getAdapter interceptors isAxiosError isCancel mergeConfig spread toFormData

Methods

create delete get getUri head options patch patchForm post postForm put putForm request

Properties

Axios

Axios: typeof Axios

AxiosError

AxiosError: typeof AxiosError

AxiosHeaders

AxiosHeaders: typeof AxiosHeaders

Cancel

Cancel: CancelStatic

CancelToken

CancelToken: CancelTokenStatic

CanceledError

CanceledError: typeof CanceledError

HttpStatusCode

HttpStatusCode: typeof HttpStatusCode

Readonly VERSION

VERSION: string

all

all: (<T>(values) => Promise<T[]>)

Type declaration

    • <T>(values): Promise<T[]>

    • Type Parameters

      • T

      Parameters

      • values: (T | Promise<T>)[]

      Returns Promise<T[]>

defaults

defaults: Omit<AxiosDefaults<any>, "headers"> & {
    headers: HeadersDefaults & {
        [key: string]: AxiosHeaderValue;
    };
}

Type declaration

formToJSON

formToJSON: ((form) => object)

Type declaration

getAdapter

getAdapter: ((adapters) => AxiosAdapter)

Type declaration

interceptors

interceptors: {
    request: AxiosInterceptorManager<InternalAxiosRequestConfig<any>>;
    response: AxiosInterceptorManager<AxiosResponse<any, any, {}>>;
}

Type declaration

isAxiosError

isAxiosError: (<T, D>(payload) => payload is AxiosError<T, D>)

Type declaration

    • <T, D>(payload): payload is AxiosError<T, D>

    • Type Parameters

      • T = any
      • D = any

      Parameters

      • payload: any

      Returns payload is AxiosError<T, D>

isCancel

isCancel: (<T>(value) => value is CanceledError<T>)

Type declaration

mergeConfig

mergeConfig: (<D>(config1, config2) => AxiosRequestConfig<D>)

Type declaration

spread

spread: (<T, R>(callback) => ((array) => R))

Type declaration

    • <T, R>(callback): ((array) => R)

    • Type Parameters

      • T
      • R

      Parameters

      • callback: ((...args) => R)
          • (...args): R

          • Parameters

            • Rest ...args: T[]

            Returns R

      Returns ((array) => R)

        • (array): R

        • Parameters

          • array: T[]

          Returns R

toFormData

toFormData: ((sourceObj, targetFormData?, options?) => GenericFormData)

Type declaration

Methods

create

delete

  • delete<T, R, D>(url, config?): Promise<R>

  • Type Parameters

    Parameters

    Returns Promise<R>

get

  • get<T, R, D>(url, config?): Promise<R>

  • Type Parameters

    Parameters

    Returns Promise<R>

getUri

  • getUri(config?): string

  • Parameters

    Returns string

head

  • head<T, R, D>(url, config?): Promise<R>

  • Type Parameters

    Parameters

    Returns Promise<R>

options

patch

  • patch<T, R, D>(url, data?, config?): Promise<R>

  • Type Parameters

    Parameters

    Returns Promise<R>

patchForm

  • patchForm<T, R, D>(url, data?, config?): Promise<R>

  • Type Parameters

    Parameters

    Returns Promise<R>

post

  • post<T, R, D>(url, data?, config?): Promise<R>

  • Type Parameters

    Parameters

    Returns Promise<R>

postForm

  • postForm<T, R, D>(url, data?, config?): Promise<R>

  • Type Parameters

    Parameters

    Returns Promise<R>

put

  • put<T, R, D>(url, data?, config?): Promise<R>

  • Type Parameters

    Parameters

    Returns Promise<R>

putForm

  • putForm<T, R, D>(url, data?, config?): Promise<R>

  • Type Parameters

    Parameters

    Returns Promise<R>

request

Settings

Member Visibility

Theme

On This Page

AxiosAxiosErrorAxiosHeadersCancelCancelTokenCanceledErrorHttpStatusCodeVERSIONalldefaultsformToJSONgetAdapterinterceptorsisAxiosErrorisCancelmergeConfigspreadtoFormDatacreatedeletegetgetUriheadoptionspatchpatchFormpostpostFormputputFormrequest