Function axios

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

  • Type Parameters

    • T = any

    • R = AxiosResponse<T, any>

    • D = any

    Parameters

    • config: AxiosRequestConfig<D>

    Returns Promise<R>

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

  • Type Parameters

    • T = any

    • R = AxiosResponse<T, any>

    • D = any

    Parameters

    • url: string
    • Optional config: AxiosRequestConfig<D>

    Returns Promise<R>

Properties

Axios AxiosError AxiosHeaders Cancel CancelToken CanceledError HttpStatusCode VERSION all defaults formToJSON getAdapter interceptors isAxiosError isCancel 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

defaults

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

Type declaration

  • headers: HeadersDefaults & {
        [key: string]: AxiosHeaderValue;
    }

formToJSON

formToJSON: ((form) => object)

Type declaration

    • (form): object

    • Parameters

      • form: GenericFormData | GenericHTMLFormElement

      Returns object

getAdapter

getAdapter: ((adapters) => AxiosAdapter)

Type declaration

    • (adapters): AxiosAdapter

    • Parameters

      • adapters: undefined | AxiosAdapterConfig | AxiosAdapterConfig[]

      Returns AxiosAdapter

interceptors

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

Type declaration

  • request: AxiosInterceptorManager<InternalAxiosRequestConfig<any>>
  • response: AxiosInterceptorManager<AxiosResponse<any, any>>

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: ((value) => value is Cancel)

Type declaration

    • (value): value is Cancel

    • Parameters

      • value: any

      Returns value is Cancel

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

    • (sourceObj, targetFormData?, options?): GenericFormData

    • Parameters

      • sourceObj: object
      • Optional targetFormData: GenericFormData
      • Optional options: FormSerializerOptions

      Returns GenericFormData

Methods

create

  • create(config?): AxiosInstance

  • Parameters

    • Optional config: CreateAxiosDefaults<any>

    Returns AxiosInstance

delete

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

  • Type Parameters

    • T = any

    • R = AxiosResponse<T, any>

    • D = any

    Parameters

    • url: string
    • Optional config: AxiosRequestConfig<D>

    Returns Promise<R>

get

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

  • Type Parameters

    • T = any

    • R = AxiosResponse<T, any>

    • D = any

    Parameters

    • url: string
    • Optional config: AxiosRequestConfig<D>

    Returns Promise<R>

getUri

  • getUri(config?): string

  • Parameters

    • Optional config: AxiosRequestConfig<any>

    Returns string

head

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

  • Type Parameters

    • T = any

    • R = AxiosResponse<T, any>

    • D = any

    Parameters

    • url: string
    • Optional config: AxiosRequestConfig<D>

    Returns Promise<R>

options

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

  • Type Parameters

    • T = any

    • R = AxiosResponse<T, any>

    • D = any

    Parameters

    • url: string
    • Optional config: AxiosRequestConfig<D>

    Returns Promise<R>

patch

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

  • Type Parameters

    • T = any

    • R = AxiosResponse<T, any>

    • D = any

    Parameters

    • url: string
    • Optional data: D
    • Optional config: AxiosRequestConfig<D>

    Returns Promise<R>

patchForm

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

  • Type Parameters

    • T = any

    • R = AxiosResponse<T, any>

    • D = any

    Parameters

    • url: string
    • Optional data: D
    • Optional config: AxiosRequestConfig<D>

    Returns Promise<R>

post

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

  • Type Parameters

    • T = any

    • R = AxiosResponse<T, any>

    • D = any

    Parameters

    • url: string
    • Optional data: D
    • Optional config: AxiosRequestConfig<D>

    Returns Promise<R>

postForm

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

  • Type Parameters

    • T = any

    • R = AxiosResponse<T, any>

    • D = any

    Parameters

    • url: string
    • Optional data: D
    • Optional config: AxiosRequestConfig<D>

    Returns Promise<R>

put

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

  • Type Parameters

    • T = any

    • R = AxiosResponse<T, any>

    • D = any

    Parameters

    • url: string
    • Optional data: D
    • Optional config: AxiosRequestConfig<D>

    Returns Promise<R>

putForm

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

  • Type Parameters

    • T = any

    • R = AxiosResponse<T, any>

    • D = any

    Parameters

    • url: string
    • Optional data: D
    • Optional config: AxiosRequestConfig<D>

    Returns Promise<R>

request

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

  • Type Parameters

    • T = any

    • R = AxiosResponse<T, any>

    • D = any

    Parameters

    • config: AxiosRequestConfig<D>

    Returns Promise<R>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc