mirror of
https://github.com/TanStack/query.git
synced 2026-11-16 22:50:20 +00:00
1.3 KiB
1.3 KiB
| id | title |
|---|---|
| infiniteQueryOptions | infiniteQueryOptions |
function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>;
Defined in: packages/lit-query/src/infiniteQueryOptions.ts:26
Preserves and types infinite query options for reuse across Lit Query APIs.
Type Parameters
TQueryFnData
TQueryFnData = unknown
TError
TError = Error
TData
TData = InfiniteData<TQueryFnData, unknown>
TQueryKey
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam
TPageParam = unknown
Parameters
options
InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
Infinite query options to preserve.
Returns
InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
The same options object.
Example
import { infiniteQueryOptions } from '@tanstack/lit-query'
const projectsOptions = infiniteQueryOptions({
queryKey: ['projects'],
queryFn: ({ pageParam }) => fetchProjects(pageParam),
initialPageParam: 0,
getNextPageParam: (lastPage) => lastPage.nextCursor,
})