查询选项

在多个地方共享 queryKey 和 queryFn，并将它们保持在一起的最佳方法之一是使用 queryOptions 辅助函数。在运行时，这个辅助函数只会返回你传递给它的内容，但在与 TypeScript 一起使用时，它具有很多优势。你可以在一个地方定义查询的所有可能选项，并且你还将获得它们的所有类型推断和类型安全。

import { queryOptions } from '@tanstack/react-query'

function groupOptions(id: number) {
  return queryOptions({
    queryKey: ['groups', id],
    queryFn: () => fetchGroups(id),
    staleTime: 5 * 1000,
  })
}

// usage:

useQuery(groupOptions(1))
useSuspenseQuery(groupOptions(5))
useQueries({
  queries: [groupOptions(1), groupOptions(2)],
})
queryClient.prefetchQuery(groupOptions(23))
queryClient.setQueryData(groupOptions(42).queryKey, newGroups)

import { queryOptions } from '@tanstack/react-query'

function groupOptions(id: number) {
  return queryOptions({
    queryKey: ['groups', id],
    queryFn: () => fetchGroups(id),
    staleTime: 5 * 1000,
  })
}

// usage:

useQuery(groupOptions(1))
useSuspenseQuery(groupOptions(5))
useQueries({
  queries: [groupOptions(1), groupOptions(2)],
})
queryClient.prefetchQuery(groupOptions(23))
queryClient.setQueryData(groupOptions(42).queryKey, newGroups)

对于无限查询，可以使用单独的 infiniteQueryOptions 辅助函数。

你仍然可以在组件级别覆盖某些选项。一个非常常见且有用的模式是创建每个组件的 select 函数。

// Type inference still works, so query.data will be the return type of select instead of queryFn

const query = useQuery({
  ...groupOptions(1),
  select: (data) => data.groupName,
})

// Type inference still works, so query.data will be the return type of select instead of queryFn

const query = useQuery({
  ...groupOptions(1),
  select: (data) => data.groupName,
})

想跳过文档吗？

想跳过文档吗？