infiniteQueryOptions
概述
1function infiniteQueryOptions<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(options: DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;2function infiniteQueryOptions<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(options: UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;3function infiniteQueryOptions<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(options: UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;DefinedInitialDataInfiniteOptions→DefinedInitialDataInfiniteOptions & QueryKeyWithDataTag：你通常可以向infiniteQueryOptions传入所有能传给useInfiniteQuery的参数。这些选项可在各类 Hook 和命令式 API（例如queryClient.infiniteQuery）之间共享。options.queryKey是必需的，它指定了用于生成选项的查询键。UnusedSkipTokenInfiniteOptions→UnusedSkipTokenInfiniteOptions & QueryKeyWithDataTag：你通常可以向infiniteQueryOptions传入所有能传给useInfiniteQuery的参数。这些选项可在各类 Hook 和命令式 API（例如queryClient.infiniteQuery）之间共享。options.queryKey是必需的，它指定了用于生成选项的查询键。UndefinedInitialDataInfiniteOptions→UndefinedInitialDataInfiniteOptions & QueryKeyWithDataTag：你通常可以向infiniteQueryOptions传入所有能传给useInfiniteQuery的参数。这些选项可在各类 Hook 和命令式 API（例如queryClient.infiniteQuery）之间共享。options.queryKey是必需的，它指定了用于生成选项的查询键。
调用签名
1function infiniteQueryOptions<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(options: DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;定义于：packages/react-query/src/infiniteQueryOptions.ts:166
你通常可以向 infiniteQueryOptions 传入所有能传给 useInfiniteQuery 的参数。
这些选项可在各类 Hook 和命令式 API（例如 queryClient.infiniteQuery）之间共享。options.queryKey 是必需的，它指定了用于生成选项的查询键。
当 initialData 已知被定义时，将选用此重载。
类型参数
TQueryFnData
TQueryFnData
TError
TError = Error
TData
TData = InfiniteData<TQueryFnData, unknown>
TQueryKey
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam
TPageParam = unknown
参数
options
DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
要使用的 DefinedInitialDataInfiniteOptions —— 即所有可传给 useInfiniteQuery 的参数，且 initialData 已知被定义。
返回值
DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>
相同选项对象，其类型已设定为使 queryKey 携带推断出的数据类型。
备注
参见 useInfiniteQuery，了解通过按钮点击或用户滚动自动拉取后续页面的示例。
参阅
useInfiniteQuery：使用这些选项运行无限查询。
示例
1import { infiniteQueryOptions, useInfiniteQuery } from '@tanstack/react-query'2 3export const projectsOptions = infiniteQueryOptions({4 queryKey: ['projects'],5 queryFn: ({ pageParam }) => fetchProjects(pageParam),6 initialPageParam: 0,7 getNextPageParam: (lastPage) => lastPage.nextId,8 initialData: { pages: [], pageParams: [] },9})10 11function Projects() {12 // `data` is never `undefined`, thanks to `initialData` — even if a refetch fails, so the13 // list stays visible alongside the error.14 const { data, isError, error } = useInfiniteQuery(projectsOptions)15 16 return (17 <div>18 {isError ? <span>Error: {error.message}</span> : null}19 <ul>20 {data.pages.map((page) => page.projects.map((p) => <li key={p.id}>{p.name}</li>))}21 </ul>22 </div>23 )24}调用签名
1function infiniteQueryOptions<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(options: UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;定义于：packages/react-query/src/infiniteQueryOptions.ts:225
你通常可以向 infiniteQueryOptions 传入所有能传给 useInfiniteQuery 的参数。
这些选项可在各类 Hook 和命令式 API（例如 queryClient.infiniteQuery）之间共享。options.queryKey 是必需的，它指定了用于生成选项的查询键。
类型参数
TQueryFnData
TQueryFnData
TError
TError = Error
TData
TData = InfiniteData<TQueryFnData, unknown>
TQueryKey
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam
TPageParam = unknown
参数
options
UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
要使用的 UnusedSkipTokenInfiniteOptions —— 即所有可传给 useInfiniteQuery 的参数。
返回值
UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>
相同选项对象，其类型已设定为使 queryKey 携带推断出的数据类型。
备注
参见 useInfiniteQuery，了解通过按钮点击或用户滚动自动拉取后续页面的示例。
参阅
useInfiniteQuery：使用这些选项运行无限查询。
示例
一个参数化工厂函数，以便每个 postId 都可复用同一选项对象：
1import { infiniteQueryOptions, useInfiniteQuery } from '@tanstack/react-query'2 3export const commentsOptions = (postId: string) =>4 infiniteQueryOptions({5 queryKey: ['post', postId, 'comments'],6 queryFn: ({ pageParam }) => fetchComments(postId, pageParam),7 initialPageParam: 0,8 getNextPageParam: (lastPage) => lastPage.nextId,9 })10 11function Comments({ postId }: { postId: string }) {12 const { data, isPending, isError, error } = useInfiniteQuery(commentsOptions(postId))13 14 if (isPending) return 'Loading...'15 if (isError) return <span>Error: {error.message}</span>16 17 return (18 <ul>19 {data.pages.map((page) => page.comments.map((c) => <li key={c.id}>{c.text}</li>))}20 </ul>21 )22}调用签名
1function infiniteQueryOptions<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(options: UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;定义于：packages/react-query/src/infiniteQueryOptions.ts:284
你通常可以向 infiniteQueryOptions 传入所有能传给 useInfiniteQuery 的参数。
这些选项可在各类 Hook 和命令式 API（例如 queryClient.infiniteQuery）之间共享。options.queryKey 是必需的，它指定了用于生成选项的查询键。
类型参数
TQueryFnData
TQueryFnData
TError
TError = Error
TData
TData = InfiniteData<TQueryFnData, unknown>
TQueryKey
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam
TPageParam = unknown
参数
options
UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
要使用的 UndefinedInitialDataInfiniteOptions —— 即所有可传给 useInfiniteQuery 的参数。
返回值
UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>
相同选项对象，其类型已设定为使 queryKey 携带推断出的数据类型。
备注
参见 useInfiniteQuery，了解通过按钮点击或用户滚动自动拉取后续页面的示例，以及如何使用 skipToken 在 postId 被设置前禁用该查询。
参阅
useInfiniteQuery：使用这些选项运行无限查询。
示例
一个参数化工厂函数，以便每个 postId 都可复用同一选项对象：
1import { infiniteQueryOptions, useInfiniteQuery } from '@tanstack/react-query'2 3export const commentsOptions = (postId: string) =>4 infiniteQueryOptions({5 queryKey: ['post', postId, 'comments'],6 queryFn: ({ pageParam }) => fetchComments(postId, pageParam),7 initialPageParam: 0,8 getNextPageParam: (lastPage) => lastPage.nextId,9 })10 11function Comments({ postId }: { postId: string }) {12 const { data, isPending, isError, error } = useInfiniteQuery(commentsOptions(postId))13 14 if (isPending) return 'Loading...'15 if (isError) return <span>Error: {error.message}</span>16 17 return (18 <ul>19 {data.pages.map((page) => page.comments.map((c) => <li key={c.id}>{c.text}</li>))}20 </ul>21 )22}参数
options
UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
要使用的 UndefinedInitialDataInfiniteOptions —— 即所有可传给 useInfiniteQuery 的参数。
options 属性
基于 UseInfiniteQueryOptions 构建。参见上方类型定义以了解其变更内容。
返回值
UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>
相同选项对象，其类型已设定为使 queryKey 携带推断出的数据类型。
返回值属性
基于 UseInfiniteQueryOptions、QueryKeyWithDataTag 构建。参见上方类型定义以了解其变更内容。