方法参数说明

defHttp 类型定义

declare const defHttp: (opt: CreateAxiosOptions) => VAxios;

方法名	参数类型	说明	TypeScript 类型
`use`	`plugin: VAxiosPlugin`	注册插件方法	`public use(plugin: VAxiosPlugin): VAxios`
`destroy`	无	销毁 axios 实例	`public destroy(): void`
`get`	`config: AxiosRequestConfig, options?: RequestOptions`	GET 请求方法	`public get<T = any>(config: AxiosRequestConfig, options?: RequestOptions): Promise<T>`
`post`	`config: AxiosRequestConfig, options?: RequestOptions`	POST 请求方法	`public post<T = any>(config: AxiosRequestConfig, options?: RequestOptions): Promise<T>`
`put`	`config: AxiosRequestConfig, options?: RequestOptions`	PUT 请求方法	`public put<T = any>(config: AxiosRequestConfig, options?: RequestOptions): Promise<T>`
`delete`	`config: AxiosRequestConfig, options?: RequestOptions`	DELETE 请求方法	`public delete<T = any>(config: AxiosRequestConfig, options?: RequestOptions): Promise<T>`
`request`	`config: AxiosRequestConfig, options?: RequestOptions`	通用请求方法	`public request<T = any>(config: AxiosRequestConfig, options?: RequestOptions): Promise<T>`

属性	说明	TypeScript 类型
`authenticationScheme`	认证方案 URL	`string` 例如 headers传入authorization是这种`Bearer token`其中`Bearer`就是认证方案，默认是`空`
`timeout`	请求超时时间,默认`10s`	`number`
`headers`	请求头默认`{ 'Content-Type': 'application/json;charset=UTF-8' }`	`object`
`requestOptions`	默认请求配置	`requestOptions`
`其他支持的配置项`	axios request config	`object`

属性	说明	TypeScript 类型
`joinParamsToUrl`	将请求参数拼接到 URL,post请求的时候添加参数到url,默认`false`	`boolean`
`formatDate`	格式化请求参数时间,默认`true`	`boolean`
`isTransformResponse`	是否处理请求结果,默认`true`	`boolean`
`isReturnNativeResponse`	是否返回原生响应头比如：需要获取响应头时使用该属性 ,默认`false`	`boolean`
`joinPrefix`	是否拼接 URL 前缀 ,`urlPrefix`和`url`是否拼接，默认`true`	`boolean`
`apiUrl`	相当于baseUrl,例如`http://api.demo.com` ,默认行为会讲`apiUrl`和`url`拼接	`string`
`urlPrefix`	请求拼接路径,例如`/api`,如果`joinPrefix`等于`true`那么则`urlPrefix`和`url`拼接,	`string`
`errorMessageMode`	错误消息提示类型,默认`modal`	`'modal'\|'notice'\|'message'`
`successMessageMode`	成功消息提示类型,默认`none`	`'modal'\|'notice'\|'message'`
`getContainer`	指定Modal挂载的HTML节点,只针对`errorMessageMode`类型是`modal`,默认`()=>document.body`	`() => HTMLElement \| null`
`zIndex`	Modal弹窗层级 ,默认`10000`	`number`
`joinTime`	给 get 请求加上时间戳参数，避免从缓存中拿数据， ,默认`true`	`boolean`
`ignoreCancelToken`	是否开启取消请求，单位时间内因为网络卡顿，多次请求，只有最后一次会被执行 ,默认`false`	`boolean`
`withToken`	是否在 header 中发送 token ,默认`true`	`boolean`
`customSuccessMessage`	自定义成功提示	`string`
`closeErrorModal`	是否关闭错误弹窗,默认`false`	`boolean`

WARNING

ErrorResponse 是请求出现错误的时候core包对外reject的一个对象，包含了请求错误详细信息，以下是参数说明