0.5.2 • Published 1 year ago

common-axios v0.5.2

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

npm npm npm axios

一个基于 axios 封装的请求库,支持请求拦截、响应拦截、错误拦截,支持 message 弹窗提示,支持接口防抖。

安装方法

npm install common-axios -S

使用方法

// 导出创建方法
import { createAxios } from "common-axios";

/* 创建 axios 实例 */
const axios =
  createAxios(/** @see http://www.axios-js.com/zh-cn/docs/#axios-create-config **/);

除了上述地址包括配置之外还支持如下字段配置

axios config 拓展属性

属性说明类型默认值
axiosDebounce接口防抖同一个接口,同一个请求方式,同样的请求参数发起了多次数据请求,当第一次发起请求的接口没有返回数据之前,后续的接口都会被取消booleanfalse
dataKey代表返回数据的 key,支持 a.b.c,例如后端返回一个对象 {a:{b:{c:'c'}}},并且可以通过泛型的方式约束返回数据类型string-
axiosResponseCallback拦截成功回调用于全局拦截function(axiosResponse: AxiosResponse) => void
axiosRequestCallback请求成功回调 用于全局拦截function(axiosRequestConfigs: AxiosRequestConfigs) => void

消息组件配置

属性说明类型默认值
messageDuration消息弹框持续时间number(毫秒)2000
messagePosition消息弹框提示位置'left'、'center'、'right''left'
messageHoverStop鼠标划入消息弹框是否停留booleanfalse
errorStatusKey代表失败的参数的 keyerrorStatusKey存在,errorStatusValue也必须存在,反之亦然。当 errorStatusKey 在后端返回的数据中对应的值和 errorStatusValue 传递的值相等的话就会开启错误 message 组件string-
errorStatusValue代表失败的参数的 valueerrorStatusValue存在,errorStatusKey也必须存在,反之亦然。errorStatusKey在后端返回的数据中对应的值和 errorStatusValue 传递的值相等或者包含存errorStatusKey在后端返回的数据中对应的值在就会开启错误 message 组件string,boolean,number,Array<string,boolean,number>-
errorMessageKey错误消息字段所对应的 key 值 在后端返回的 data 字段中代表错误消息的 keystring-
errorMessageValue错误消息提示的自定义内容 在后端返回的 data 字段中代表错误消息的 key 多对应的值 错误消息提示的自定义内容优先级高于 errorMessageKey 所对应的内容string-
errorMessageDuration错误消息持续时间(毫秒) 如果配置了messageDuration,则会执行messageDuration所对应的配置number-
errorMessagePosition错误消息提示的位置 如果配置了messagePosition 属性 则执行 messagePosition 的配置'left'、'center'、'right''left'
errorMessageHoverStop鼠标划入错误消息是否停留 如果没有配置该配置,且配置了 messageHoverStop 属性 则执行 messageHoverStop的配置booleanfalse
successStatusKey代表成功的参数的 keyerrorStatusKeystring-
successStatusKey代表成功的参数的 keystring-
successMessageKey成功消息字段所对应的 key 在后端返回的 data 字段中代表成功消息的 keystring-
successMessageValue成功消息提示的自定义内容 在后端返回的 data 字段中代表成功消息的 key 多对应的值 自定义内容优先级高于 successMessageKey 所对应的内容string-
successStatusValue代表成功的参数的 value errorStatusValuestring,boolean,number,Array<string,boolean,number>-
successMessageDuration成功消息弹框持续时间(毫秒) 如果没有配置该属性且配置了messageDuration属性,则执行 messageDuration 的配置number2000
successMessagePosition成功消息提示的位置 如果没有配置该属性但是配置了messagePosition 属性 则执行 messagePosition 的配置'left'、'center'、'right''left'
successMessageHoverStop鼠标划入成功消息弹框是否停留 如果没有配置该配置,但是配置了 messageHoverStop 属性则执行 messageHoverStop 的配置booleanfalse

具体使用方法

/* get请求参数位置以及请求配置 【 head 】请求如同*/
const result = await axiosHelpers.get(<url>,<params>,<config>)

/* post请求参数位置以及请求配置 【 put 】,【 patch 】请求如同 */
const result = await axiosHelpers.post(<url>,<data>,<config>)

/* delete请求参数位置以及请求配置 【 option 】请求如同 */
const result = await axiosHelpers.delete(<url>,<{params:params,data:data}>,<config>)

注意

1.目前来说所有的请求第二个参数均是请求参数,第三个参数均是请求配置,如果不需要请求参数,还请用占位符代替!!!
0.5.2

1 year ago

0.4.35

2 years ago

0.4.36

2 years ago

0.4.34

2 years ago

0.5.0

2 years ago

0.5.1

2 years ago

0.4.32

2 years ago

0.4.33

2 years ago

0.4.31

2 years ago

0.4.1

2 years ago

0.4.3

2 years ago

0.4.2

2 years ago

0.3.9

2 years ago

0.3.91

2 years ago

0.4.0

2 years ago

0.3.0

2 years ago

0.2.1

2 years ago

0.2.0

2 years ago

0.3.6

2 years ago

0.2.7

2 years ago

0.1.8

2 years ago

0.3.5

2 years ago

0.2.6

2 years ago

0.1.7

2 years ago

0.3.8

2 years ago

0.2.9

2 years ago

0.3.7

2 years ago

0.2.8

2 years ago

0.1.9

2 years ago

0.3.2

2 years ago

0.2.3

2 years ago

0.3.1

2 years ago

0.2.2

2 years ago

0.3.4

2 years ago

0.2.5

2 years ago

0.1.6

2 years ago

0.2.4

2 years ago

0.1.0

2 years ago

0.1.2

2 years ago

0.1.1

2 years ago

0.1.4

2 years ago

0.1.3

2 years ago

0.1.5

2 years ago

0.0.9

2 years ago

0.0.8

2 years ago

0.0.7

2 years ago

0.0.6

2 years ago

0.0.5

2 years ago

0.0.4

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago