v2.0.4

Refactor

• useRequest 支持传入自定义插件 #204 (3280f44)
• 导出部分缺失的类型 #215 #217 (35b07a4)

Refactor

• useRequest supports passing custom plugins #204 (3280f44)
• expose some types #215 #217 (35b07a4)

v2.0.3

Refactor

• 导出 definePlugin 方法 (2a03d38)

---

Refactor

• expose definePlugin (2a03d38)

v2.0.2

Refactor

• 添加 可选链语法 的转换 #199 (f1c79fb)

---

Refactor

• Convert optional chaining syntax #199 (f1c79fb)

v2.0.1

变更列表

• 使用 vue-demi 兼容 vue2 #38

• 新增自定义缓存 getCache 、setCache 和 clearCache。

• 开启缓存的情况下，设置了相同 cacheKey 的请求将会被缓存和复用。

• 新增 runAsync 和 refreshAsync，将返回 Promise。

• 新增 definePlugin，可以通过插件来扩展 useRequest 的功能。

• 节流/防抖模式下可以使用 runAsync 返回正常的 Promise。

• 新增 useRequestProvider hooks，用于注入 options 配置。

• 新增 refreshDepsAction 选项，用于自定义 refreshDeps 触发后的行为。

• refreshDepsAction 在 manual=true 时，也会被 refreshDeps 的改变而触发。

• 新增 loadingKeep。

• 移除 内部集成请求库，service 不再支持字符或对象。 迁移帮助

• 移除 formatResult。 迁移帮助

• 移除 queryKey，即移除了并行模式 迁移帮助

• run 不再返回 Promise 迁移帮助

• 请求出错时，data 不再会被清空#82

• 修改 ready 的逻辑 迁移帮助

• ready 支持传入一个返回布尔值的函数 #166

• data 和 error 改为 shallowRef

• usePagination 移除了 reload 方法和 reloading。如需要对应的需求，可自行实现。

• 移除了 RequestConfig 组件 迁移帮助

• 重构了useLoadMore，具体 API 可查看详情 API 说明

• cacheKey 支持传入函数: cacheKey: (params?: P) => string

• refreshDeps支持传入 一个函数，返回一个值 、是一个 ref 、一个响应式对象 或是由以上类型的值组成的数组 #166

  useRequest(getUser,{
    cacheKey: (params?:P):string => {
      <!-- 初始化时，params 会为 undefined，需要手动判断并返回一个空字符串 -->
      if(params){
        return `user-key-${params[0].name}`
      }
      return ''
    }
  })

• 部分options 支持响应式，如下所示

  type ReactivityOptions = {
    loadingDelay: number | Ref<number>;
    loadingKeep: number | Ref<number>;
    pollingInterval: number | Ref<number>;
    debounceInterval: number | Ref<number>;
    debounceOptions: DebounceOptions | Reactive<DebounceOptions>;
    throttleInterval: number | Ref<number>;
    throttleOptions: ThrottleOptions | Reactive<ThrottleOptions>;
    refreshOnWindowFocus: boolean | Ref<boolean>;
    refocusTimespan: number | Ref<number>;
    errorRetryCount: number | Ref<number>;
    errorRetryInterval: number | Ref<number>;
  };

迁移帮助

1. service 不再支持字符或对象。期望用户可以根据其他第三方请求库进行封装（如 axios），只要提供 Promise 即可

const getUser = userName => {
  return axios.get("api/user", {
    params: {
      name: userName,
    },
  });
};
useRequest(getUser, options);

2. 移除 formatResult。期望用户自行在 service 中返回最终格式的数据。

const getUser = async () => {
  const results = await axios.get("api/user");
  // 在此处处理最终的数据
  return results.data;
};

3. 移除 queryKey，即移除了并行模式。期望将每个请求动作和 UI 封装为一个组件，而不是把所有请求都放到父级。

4. 修改 ready 的逻辑

   • 当 manual=false 时，每次 ready 从 false 变为 true 时，都会自动发起请求，会带上参数 options.defaultParams。
   • 当 manual=true 时，只要 ready为 false，则无法发起请求。

5. run 不再返回 Promise。直接用 runAsync 替代原本的 run。

6. 可自行通过 useRequestProvider 封装 。

useLoadMore API

Options

参数	说明	类型
manual	当设置为 true 时，你需要手动触发 loadMore 或者 loadMoreAsync 才会发起请求。默认为 false	boolean
ready	当 manual=false 时，每次 ready 从 false 变为 true 时，都会自动触发 refresh。当 manual=true 时，只要 ready 为 false，则无法发起请求。	Ref<boolean> | () => boolean
refreshDeps	改变后自动触发 refresh，如果设置了 refreshDepsAction 则触发 refreshDepsAction	WatchSource<any> | WatchSource<any>[]
refreshDepsAction	refreshDeps改变后触发	() => void
debounceInterval	以防抖策略处理请求	number | Ref<number>
debounceOptions	防抖参数	{leading: false, maxWait: undefined, trailing: true}
throttleInterval	以节流策略处理请求	number | Ref<number>
throttleOptions	节流参数	{leading: false, trailing: true}
errorRetryCount	发生错误时的错误重试次数	number | Ref<number>
errorRetryInterval	发生错误时的错误重试间隔时间	number | Ref<number>
isNoMore	判断是否还有更多数据	(data?: R) => boolean
onBefore	service 执行前触发	() => void
onAfter	service 执行完成时触发	() => void
onSuccess	service resolve 时触发	(data: R) => void
onError	service reject 时触发	(error: Error) => void

Result

参数	说明	类型
data	service 返回的数据，必须包含 list 数组，类型为 { list: any[], ...other }	Ref<R>
dataList	data 的 list 数组	Ref<R['list']>
loading	是否正在进行请求	Ref<boolean>
loadingMore	是否正在加载更多	Ref<boolean>
noMore	是否有更多数据，需要配合 options.isNoMore 使用	Ref<boolean>
error	service 返回的错误	Error
loadMore	加载更多数据，会自动捕获异常，通过 options.onError 处理	() => void
loadMoreAsync	加载更多数据，返回 Promise，需要自行处理错误	() => Promise<R>
refresh	刷新加载第一页数据，会自动捕获异常，通过 options.onError 处理	() => void
refreshAsync	刷新加载第一页数据，返回 Promise，需要自行处理错误	() => Promise<R>
mutate	直接修改 data 的结果	(arg: (oldData: R) => R) => void | (newData: R) => void
cancel	取消请求	() => void

---

Changelog

• Use vue-demi to be compatible with Vue 2 #38
• Added custom cache getCache, setCache, and clearCache.
• When caching is enabled, requests with the same cacheKey will be cached and reused.
• Added runAsync and refreshAsync, which return a Promise.
• Added definePlugin to extend the functionality of useRequest through plugins.
• In throttle/debounce mode, runAsync can be used to return a normal Promise.
• Added useRequestProvider hooks to inject options configuration.
• Added refreshDepsAction option to customize the behavior after refreshDeps is triggered.
• refreshDepsAction will also be triggered by changes in refreshDeps when manual=true.
• Added loadingKeep.
• Removed the integrated request library and service no longer supports strings or objects. Migration Guide
• Removed formatResult. Migration Guide
• Removed queryKey, i.e., parallel mode is removed Migration Guide
• run no longer returns a Promise Migration Guide
• When a request fails, data is no longer cleared #82
• Modified the logic of ready Migration Guide
• **ready now supports passing a function t...

v1.2.4

Refactor

• replacing IIFE with UMD modules (2f05be8)

v1.2.3

Bug Fixes

• Fix incorrect import path #71 (#72) (2926510)

v1.2.2

Bug Fixes

• Fix nullish operator is not transform

v1.2.1

Features

• core: add throttle and debounce options #63 (decbbd3)

v1.2.0

Features

• usePagination: add changePagination() to modify both current and pageSize #43 (c3822f0)
• add onBefore() and onAfter() hooks #42 (135e76f)
• add reloading to record the loading status of reload() #41 (5034f2c)

Performance Improvements

• optimization package size, volume reduction 88% #44 (6a5b074, ffbc5d1, ce233ca, #45(4272062))

⚠ BREAKING CHANGES

• not support IE11 #44 (686e4cd)

v1.1.1

Bug Fixes

• usePagination: defaultParams.current and defaultParams.pageSize should work if manual: true (3ca5fd7), closes #40