* docs({react,preact,angular,solid,svelte,vue}-query): describe the 'initialData' overloads as 'known to be defined' and 'omitted or may be undefined'
* docs({react,preact,angular,solid,svelte,vue}-query): regenerate reference docs
* docs({react,preact,angular,solid,svelte,vue}-query): mention an 'initialData' function that may return 'undefined' in the 'Undefined' overload descriptions
* docs({react,preact,angular,solid,svelte,vue}-query): regenerate reference docs
9.4 KiB
| id | title | redirect_from | |
|---|---|---|---|
| infiniteQueryOptions | infiniteQueryOptions |
|
Overview
function infiniteQueryOptions<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(options: InfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object): ReturnType<DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;
function infiniteQueryOptions<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(options: InfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object): ReturnType<UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;
ReturnType<DefinedInitialDataInfiniteOptions>→ReturnType<DefinedInitialDataInfiniteOptions> & QueryKeyWithDataTag: You can generally pass everything toinfiniteQueryOptionsthat you can also pass touseInfiniteQuery. These options can be shared across hooks and imperative APIs such asqueryClient.infiniteQuery.options.queryKeyis required and is the query key to generate options for.ReturnType<UndefinedInitialDataInfiniteOptions>→ReturnType<UndefinedInitialDataInfiniteOptions> & QueryKeyWithDataTag: You can generally pass everything toinfiniteQueryOptionsthat you can also pass touseInfiniteQuery. These options can be shared across hooks and imperative APIs such asqueryClient.infiniteQuery.options.queryKeyis required and is the query key to generate options for.
See also: Parameters · Returns
Call Signature
function infiniteQueryOptions<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(options: InfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object): ReturnType<DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;
Defined in: packages/solid-query/src/infiniteQueryOptions.ts:107
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 known to be defined.
Type Parameters
TQueryFnData
TQueryFnData
TError
TError = Error
TData
TData = InfiniteData<TQueryFnData, unknown>
TQueryKey
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam
TPageParam = unknown
Parameters
options
InfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object
The DefinedInitialDataInfiniteOptions to use — everything you can pass to useInfiniteQuery, with initialData known to be defined.
Returns
ReturnType<DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>
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 { For } from 'solid-js'
import { infiniteQueryOptions, useInfiniteQuery } from '@tanstack/solid-query'
const projectsOptions = infiniteQueryOptions({
queryKey: ['projects'],
queryFn: ({ pageParam }) => fetchProjects(pageParam),
initialPageParam: 0,
getNextPageParam: (lastPage) => lastPage.nextId,
initialData: { pages: [], pageParams: [] },
})
function Projects() {
// `projectsQuery.data` is never `undefined`, thanks to `initialData` — even if a refetch fails, so the
// list stays visible alongside the error.
const projectsQuery = useInfiniteQuery(() => projectsOptions)
return (
<div>
{projectsQuery.isError ? <span>Error: {projectsQuery.error.message}</span> : null}
<ul>
<For each={projectsQuery.data.pages}>
{(page) => <For each={page.projects}>{(p) => <li>{p.name}</li>}</For>}
</For>
</ul>
</div>
)
}
Call Signature
function infiniteQueryOptions<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(options: InfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object): ReturnType<UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;
Defined in: packages/solid-query/src/infiniteQueryOptions.ts:174
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
InfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object
The UndefinedInitialDataInfiniteOptions to use — everything you can pass to useInfiniteQuery.
Returns
ReturnType<UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>
The same options object, typed so that queryKey carries the inferred data type.
See
useInfiniteQuery to run an infinite query with these options.
Example
A parameterized factory, so the same options object can be reused per postId:
import { For, Match, Switch } from 'solid-js'
import { infiniteQueryOptions, useInfiniteQuery } from '@tanstack/solid-query'
const commentsOptions = (postId: string) =>
infiniteQueryOptions({
queryKey: ['post', postId, 'comments'],
queryFn: ({ pageParam }) => fetchComments(postId, pageParam),
initialPageParam: 0,
getNextPageParam: (lastPage) => lastPage.nextId,
})
function Comments(props: { postId: string }) {
const commentsQuery = useInfiniteQuery(() => commentsOptions(props.postId))
return (
<Switch>
<Match when={commentsQuery.isPending}>Loading...</Match>
<Match when={commentsQuery.isError}>Error: {commentsQuery.error.message}</Match>
<Match when={commentsQuery.isSuccess}>
<ul>
<For each={commentsQuery.data.pages}>
{(page) => <For each={page.comments}>{(c) => <li>{c.text}</li>}</For>}
</For>
</ul>
</Match>
</Switch>
)
}
Parameters
options
InfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object
The UndefinedInitialDataInfiniteOptions to use — everything you can pass to useInfiniteQuery.
options properties
Built from InfiniteQueryOptions. See the type above for what it changes.
Returns
ReturnType<UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>
The same options object, typed so that queryKey carries the inferred data type.
Result properties
Built from InfiniteQueryOptions, QueryKeyWithDataTag. See the type above for what it changes.