Reference
Request helpers
Top-level axios functions: request helpers, defaults merging, and error predicates.
All of these are exported from the package root and are also available as
properties of the default axios instance.
| Export | Kind | Summary |
|---|---|---|
getAdapter | function | — |
toFormData | function | — |
formToJSON | function | — |
isAxiosError | function | — |
spread | function | — |
isCancel | function | — |
all | function | — |
mergeConfig | function | — |
create | function | — |
getAdapter
No doc comment in the pinned source.
axios.getAdapter(( adapters: AxiosAdapterConfig | AxiosAdapterConfig[] | undefined ): AxiosAdapter)toFormData
No doc comment in the pinned source.
axios.toFormData(( sourceObj: object, targetFormData?: GenericFormData, options?: FormSerializerOptions ): GenericFormData)formToJSON
No doc comment in the pinned source.
axios.formToJSON((form: GenericFormData | GenericHTMLFormElement): object)isAxiosError
No doc comment in the pinned source.
axios.isAxiosError(<T = any, D = any, P = any>( payload: any ): payload is AxiosError<T, D, P>)spread
No doc comment in the pinned source.
axios.spread(<T, R>(callback: (...args: T[]) => R): (array: T[]) => R)isCancel
No doc comment in the pinned source.
axios.isCancel(<T = any, D = any, P = any>(value: any): value is CanceledError<T, D, P>)all
No doc comment in the pinned source.
axios.all(<T>(values: Array<T | Promise<T>>): Promise<T[]>)mergeConfig
No doc comment in the pinned source.
axios.mergeConfig(<D = any, P = any>( config1: AxiosRequestConfig<D, P>, config2: AxiosRequestConfig<D, P> ): AxiosRequestConfig<D, P>)create
No doc comment in the pinned source.
axios.create((config?: CreateAxiosDefaults): AxiosInstance)Related
- Instance API — the same helpers on a configured instance
- Request config — options accepted by every helper