7.5 KiB
| id | title |
|---|---|
| infiniteQueryOptions | infiniteQueryOptions |
Call Signature
function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData, unknown>, TError>;
Defined in: preact-query/src/infiniteQueryOptions.ts:157
You can generally pass everything to infiniteQueryOptions that you can also pass to useInfiniteQuery.
These options can be shared across hooks and imperative APIs such as queryClient.infiniteQuery.
options.queryKey is required and is the query key to generate options for.
This overload is selected when initialData is set.
Type Parameters
TQueryFnData
TQueryFnData
TError
TError = Error
TData
TData = InfiniteData<TQueryFnData, unknown>
TQueryKey
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam
TPageParam = unknown
Parameters
options
DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
The DefinedInitialDataInfiniteOptions to use — everything you can pass to useInfiniteQuery, with initialData set.
Returns
The same options object, typed so that queryKey carries the inferred data type.
See
useInfiniteQuery to run an infinite query with these options.
Example
import { infiniteQueryOptions, useInfiniteQuery } from '@tanstack/preact-query'
export const projectsOptions = infiniteQueryOptions({
queryKey: ['projects'],
queryFn: ({ pageParam }) => fetchProjects(pageParam),
initialPageParam: 0,
getNextPageParam: (lastPage) => lastPage.nextId,
initialData: { pages: [], pageParams: [] },
})
function Projects() {
const { data } = useInfiniteQuery(projectsOptions)
return <>{data.pages.map((page) => page.projects.map((p) => <p key={p.id}>{p.name}</p>))}</>
}
Call Signature
function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): OmitKeyof<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, "queryFn"> & object & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData, unknown>, TError>;
Defined in: preact-query/src/infiniteQueryOptions.ts:233
You can generally pass everything to infiniteQueryOptions that you can also pass to useInfiniteQuery.
These options can be shared across hooks and imperative APIs such as queryClient.infiniteQuery.
options.queryKey is required and is the query key to generate options for.
Type Parameters
TQueryFnData
TQueryFnData
TError
TError = Error
TData
TData = InfiniteData<TQueryFnData, unknown>
TQueryKey
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam
TPageParam = unknown
Parameters
options
UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
The UnusedSkipTokenInfiniteOptions to use — everything you can pass to useInfiniteQuery.
Returns
The same options object, typed so that queryKey carries the inferred data type.
Examples
import { infiniteQueryOptions } from '@tanstack/preact-query'
export const projectsOptions = infiniteQueryOptions({
queryKey: ['projects'],
queryFn: ({ pageParam }) => fetchProjects(pageParam),
initialPageParam: 0,
getNextPageParam: (lastPage) => lastPage.nextId,
})
A parameterized factory, reused across a hook and an imperative call with the same cache entry:
import {
infiniteQueryOptions,
noop,
useInfiniteQuery,
} from '@tanstack/preact-query'
export const commentsOptions = (postId: string) =>
infiniteQueryOptions({
queryKey: ['post', postId, 'comments'],
queryFn: ({ pageParam }) => fetchComments(postId, pageParam),
initialPageParam: 0,
getNextPageParam: (lastPage) => lastPage.nextId,
})
function Comments({ postId }: { postId: string }) {
const result = useInfiniteQuery(commentsOptions(postId))
if (!result.isSuccess) return 'Loading...'
return (
<>
{result.data.pages.map((page) => page.comments.map((c) => <p key={c.id}>{c.text}</p>))}
</>
)
}
// Elsewhere, e.g. to warm the cache before rendering `<Comments>`:
queryClient.infiniteQuery(commentsOptions(postId)).catch(noop)
See
useInfiniteQuery to run an infinite query with these options.
Call Signature
function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData, unknown>, TError>;
Defined in: preact-query/src/infiniteQueryOptions.ts:309
You can generally pass everything to infiniteQueryOptions that you can also pass to useInfiniteQuery.
These options can be shared across hooks and imperative APIs such as queryClient.infiniteQuery.
options.queryKey is required and is the query key to generate options for.
Type Parameters
TQueryFnData
TQueryFnData
TError
TError = Error
TData
TData = InfiniteData<TQueryFnData, unknown>
TQueryKey
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam
TPageParam = unknown
Parameters
options
UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
The UndefinedInitialDataInfiniteOptions to use — everything you can pass to useInfiniteQuery.
Returns
The same options object, typed so that queryKey carries the inferred data type.
Examples
import { infiniteQueryOptions } from '@tanstack/preact-query'
export const projectsOptions = infiniteQueryOptions({
queryKey: ['projects'],
queryFn: ({ pageParam }) => fetchProjects(pageParam),
initialPageParam: 0,
getNextPageParam: (lastPage) => lastPage.nextId,
})
A parameterized factory, reused across a hook and an imperative call with the same cache entry:
import {
infiniteQueryOptions,
noop,
useInfiniteQuery,
} from '@tanstack/preact-query'
export const commentsOptions = (postId: string) =>
infiniteQueryOptions({
queryKey: ['post', postId, 'comments'],
queryFn: ({ pageParam }) => fetchComments(postId, pageParam),
initialPageParam: 0,
getNextPageParam: (lastPage) => lastPage.nextId,
})
function Comments({ postId }: { postId: string }) {
const result = useInfiniteQuery(commentsOptions(postId))
if (!result.isSuccess) return 'Loading...'
return (
<>
{result.data.pages.map((page) => page.comments.map((c) => <p key={c.id}>{c.text}</p>))}
</>
)
}
// Elsewhere, e.g. to warm the cache before rendering `<Comments>`:
queryClient.infiniteQuery(commentsOptions(postId)).catch(noop)
See
useInfiniteQuery to run an infinite query with these options.