React Query 中 useSuspenseQuery 类型声明问题解析

在 React Query 5.59.20 版本中，开发者在使用 useSuspenseQuery 时遇到了类型声明上的兼容性问题。这个问题主要源于 UseQueryOptions 和 UseSuspenseQueryOptions 类型之间的差异。

问题背景

在之前的版本中，useSuspenseQuery 可以直接接受 UseQueryOptions 类型作为参数。但在升级后，这种用法会导致类型错误，提示 skipToken 类型不兼容。这是因为 useSuspenseQuery 不支持 skipToken 功能，而普通 useQuery 是支持的。

类型差异分析

React Query 团队在最近的更新中对这两种查询选项类型做了更严格的区分：

1. UseQueryOptions 允许 queryFn 为 skipToken 或查询函数
2. UseSuspenseQueryOptions 只允许 queryFn 为查询函数

这种区分是合理的，因为 Suspense 模式下的查询本质上不能"跳过" - 它必须立即返回数据或抛出 Promise。

解决方案

对于需要同时支持普通查询和 Suspense 查询的抽象场景，最佳实践是：

1. 使用 UseSuspenseQueryOptions 作为基础类型
2. 这个类型可以安全地传递给 useQuery 和 useSuspenseQuery

export function useStandardSuspenseQuery<
    TArgs extends unknown[],
    TData,
    TError,
    TVariables,
    TQueryKey extends QueryKey,
>(
    fn: (api: ApiClient, ...args: TArgs) => UseSuspenseQueryOptions<TData, TError, TVariables, TQueryKey>,
    ...args: TArgs
) {
    const apiClient = useApiClient();
    return useSuspenseQuery(fn(apiClient, ...args));
}

类型兼容性说明

UseSuspenseQueryOptions 是 UseQueryOptions 的子集，因此：

• UseSuspenseQueryOptions 可以安全地传递给 useQuery
• 但反过来则不行，因为 useSuspenseQuery 不能处理 skipToken

这种类型设计确保了 Suspense 查询的严格性，同时保持了与普通查询的兼容性。

总结

React Query 的类型系统经过精心设计，以确保 API 的安全使用。在构建查询抽象时，应该根据实际需要选择最严格的类型 - 如果需要支持 Suspense，就使用 UseSuspenseQueryOptions，这样可以保证在所有场景下都能正常工作。