用途:在 TanStack Query 跨大版本迁移(React Query v3、React Query v4、TanStack Query v5、Vue Query v5、Svelte Query v6)时,按官方迁移指南处理破坏性变更,包括已移除的重载、对象语法、移除的回调以及配置项改名。
主要能力与用法:
- 统一对象语法:useQuery({ queryKey: [...], queryFn: ... });查询客户端使用 queryClient.prefetchQuery({ queryKey, queryFn })。不支持 v4 的 useQuery(['todos'], fn) 重载写法;v5 移除 hook 与客户端重载,改为单一对象签名。
- 配置项改名:cacheTime 改为 gcTime,表示未使用查询的垃圾回收时间,例如 defaultOptions: { queries: { gcTime: 10 * 60 * 1000 } }。
- 迁移 keepPreviousData:改为 placeholderData: keepPreviousData,并从 @tanstack/react-query 导入 keepPreviousData。
- 移除查询回调:v5 删除 onSuccess 等查询回调,需在查询选项之外(如组件 useEffect 中依据 data 变化)响应数据变化。
适用场景:React、Vue、Svelte 项目升级 TanStack Query 大版本,或清理旧版重载与回调写法。
限制:资料仅提供 React 迁移示例;Vue Query v5、Svelte Query v6 的具体差异、版本号对应关系及完整迁移清单暂未提供。需结合官方迁移文档核对,不能仅凭示例推断未列出的改动。