公共 API
VueRequest 通常由 Return Values、Service 和 Options 三个部分组成
const { ...ReturnValues } = useRequest<R, P, FR>(Service, Options);
TS 泛型说明
R 是返回 data 的泛型
P 是 params 的泛型 （注：该泛型受到 unknown[] 的约束）
FR 是 formatresult 返回的 data 的类型 （注：后面文档提到的 R 泛型，在使用了 formatresult 后均要使用 FR 代替）
Return Values
data
类型：
Ref<R | undefined>默认值：
undefined接口返回的数据，如果有传入 formatResult，则为格式化后的
data
loading
类型：
Ref<boolean>默认值：
falseService 请求的执行状态
reloading New in 1.2.0
类型：
Ref<boolean>默认值：
false是否正在刷新，用于记录
reload()是否正在触发。
params
类型：
Ref<P[]>默认值：
[]Service 的请求参数
示例：
function getUser(name) {
return fetch('api/user?' + new URLSearchParams({ name })).then(res => res.json());
}
const { params, run } = useRequest(getUser, {
defaultParams: ['John'],
});
// 默认请求时，如果存在 defaultParams， 则 params.value 将会等于 defaultParams，否则为空数组
// 当 run 传入参数时，此时的参数将会同步到 params 里面
run('Benny'); // params.value 等于 ['Benny']
error
类型：
Ref<Error | undefined>默认值：
undefined如果在内部抛出了一个错误，则会被
error接收并返回
queries
类型：
Queries<R, P>默认值：
Object默认情况下，新请求的数据将会覆盖旧请求的数据。当启用
queryKey()后，queries能够同时存储多次请求的结果，实现并行的效果.注意
queries是一个reactive在新窗口打开 对象Queries的类型如下type Queries<R, P> = { loading: boolean; data: R | undefined; error: Error | undefined; params: P[]; run: (...params: P[]) => Promise<R>; cancel: () => void; refresh: () => Promise<R>; mutate: (arg: (oldData: R) => R) => void | (newData: R) => void; }参考：并发请求
run
类型：
(...params: P[]) => Promise<R>手动触发 Service 的请求
注意
当开启了 debounceInterval 或者 throttleInterval 模式后
run的返回结果有可能是Promise<null>
cancel
类型：
() => void- 手动取消本次请求
- 停止轮询功能
refresh
reload
类型：
() => void用于清空
queries数据，以及所有请求状态（包括data）。如果manual为false的情况下，还会使用defaultParams重新触发run()
mutate
Service
用于发起获取资源的请求 ，可参考 数据请求
请求函数
类型：
(...params: P[]) => Promise<R>| (...params: P[]) => string| (...params: P[]) => ({ url: string; [key: string]: any; })
详情：
可以通过传入一个返回值为
Promise、字符串 或者 对象 的函数。这里我们更加推荐返回一个Promise。你可以借助第三方的请求库（如axios）来帮你生成一个用于发起获取资源的请求Promise函数。import { useRequest } from 'vue-request'; import axios from 'axios'; const getUser = () => { return axios.get('api/user'); }; const { data } = useRequest(getUser);
字符串
类型：
string详情：
如果你传入一个字符串，或者通过请求函数返回一个字符串的方式调用，那么我们将会使用全局下的
fetch()在新窗口打开 方法发起获取资源的请求，该字符串将会作为获取资源的 URL
对象
类型：
{ url: string; [key: string]: any; }详情：
如果你传入一个对象，或者通过请求函数返回一个对象的方式调用，那么我们将会使用全局下的
fetch()在新窗口打开 方法发起获取资源的请求。该对象必须包含一个属性名为 URL 的键值对，该值将会作为获取资源的 URL
Options
loadingDelay
pollingInterval
类型：
number默认值：
undefined详情：
通过设置轮询间隔毫秒值，可以进入轮询模式，定时触发请求。可以通过
run/cancel来 开启/停止 轮询。在manual设置为true时，需要手动执行一次run后，才开始轮询。- 间隔值必须大于
0才会生效
- 间隔值必须大于
参考： 轮询
pollingWhenHidden
类型：
boolean默认值：
false详情：
当
pollingInterval大于0时才生效。默认情况下，轮询在屏幕不可见时，会暂停轮询。当设置成true时，在屏幕不可见时，轮询任务依旧会定时执行。参考： 屏幕不可见时轮询
pollingWhenOffline
类型：
boolean默认值：
false详情：
当
pollingInterval大于0时才生效。默认情况下，轮询在网络不可用时，会暂停轮询。当设置成true时，在网络不可用时，轮询任务依旧会定时执行。参考： 网络离线时轮询
debounceInterval
debounceOptions New in 1.2.2
- 类型：
Object - 默认值：
{
leading: false,
maxWait: undefined,
trailing: true
}
详情：
leading(boolean): 指定在延迟开始前调用。maxWait(number): 设置请求方法允许被延迟的最大值。trailing(boolean): 指定在延迟结束后调用。
throttleInterval
throttleOptions New in 1.2.2
- 类型：
Object - 默认值：
{
leading: true,
trailing: true,
}
详情：
leading(boolean): 指定调用在节流开始前。trailing(boolean): 指定调用在节流结束后。
refreshOnWindowFocus
类型：
boolean默认值：
false详情：
当设置为
true时，则在浏览器窗口触发 focus在新窗口打开 和 visibilitychange在新窗口打开 时，会重新发起请求。参考： 聚焦时重新请求
refocusTimespan
类型：
number默认值：
5000详情：
当 refreshOnWindowFocus 设置为
true时，你可以通过设置间隔的毫秒数，来限制refresh的执行间隔，默认为 5000ms参考： 重新聚焦间隔时间
cacheKey
类型：
string默认值：
undefined详情：
参考： 缓存
cacheTime
类型：
number默认值：
600000详情：
当开启缓存后，你可以通过设置
cacheTime来告诉我们缓存的过期时间。当缓存过期后，我们会将其删除。默认为 600000 毫秒，即 10 分钟参考： 缓存时间
staleTime
类型：
number默认值：
0详情：
如果你能确保缓存下来的数据，在一定时间内不会有任何更新的，我们建议你设置一个合理的毫秒数
- 默认为
0，意味着不保鲜，每次都会重新发起请求 - 设置为
-1则意味着缓存永不过期
- 默认为
参考： 保鲜时间
errorRetryCount
类型：
number默认值：
0详情：
最大错误重试次数
参考： 错误重试次数
errorRetryInterval
类型：
number默认值：
0详情：
默认情况下，VueRequest 使用二进制指数退避算法在新窗口打开 来帮你计算出合适的间隔时间，你也可以通过设置
errorRetryInterval来覆盖默认行为参考： 错误重试间隔时间
manual
defaultParams
类型：
P[]默认值：
[]详情：
如果
manual设置为false，在自动执行 run 的时候，将会把defaultParams作为请求参数
ready
类型：
Ref<boolean>默认值：
true详情：
只有当
ready为true时，才会发起请求。- 该行为只会触发一次。如果想要多次触发，建议使用
refreshDeps或者自己实现相关逻辑
- 该行为只会触发一次。如果想要多次触发，建议使用
参考： 依赖请求
initialData
类型：
R默认值：
undefined详情：
默认的
data
refreshDeps
类型：
WatchSource<any>[]默认值：
[]详情：
refreshDeps的变化，会触发refresh的重新执行。其本质只是对watch在新窗口打开 的封装watch(refreshDeps, refresh);参考： 依赖刷新
queryKey
类型：
(...params: P[]) => string详情：
根据 params，获取当前请求的 key，设置之后，我们会在
queries中同时维护不同 key 值的请求状态。参考： 并发请求
formatResult
类型：
(data: R) => FR详情：
格式化请求结果，入参为原本接口返回的
data，出参为处理过后的dataimport { defineComponent } from 'vue'; import { useRequest } from 'vue-request'; export default defineComponent({ name: 'App', setup() { const { data } = useRequest<number, any, string>('api/timestramp', { formatResult: data => { return new Date(data); }, }); return () => <div>{data.value}</div>; }, });
onSuccess
类型：
(data: R, params: P[]) => void详情：
当 Service
resolve时触发，参数为data和params- 如果有
formatResult，则data为格式化后数据。
- 如果有