Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

infiniteQueryOptions.md

63 lines1.4 KB

1---
2id: infiniteQueryOptions
3title: infiniteQueryOptions
4---
5​
6# Function: infiniteQueryOptions()
7​
8```ts
9function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>;
10```
11​
12Defined in: [packages/lit-query/src/infiniteQueryOptions.ts:26](https://github.com/TanStack/query/blob/main/packages/lit-query/src/infiniteQueryOptions.ts#L26)
13​
14Preserves and types infinite query options for reuse across Lit Query APIs.
15​
16## Type Parameters
17​
18### TQueryFnData
19​
20`TQueryFnData` = `unknown`
21​
22### TError
23​
24`TError` = `Error`
25​
26### TData
27​
28`TData` = `InfiniteData`\<`TQueryFnData`, `unknown`\>
29​
30### TQueryKey
31​
32`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
33​
34### TPageParam
35​
36`TPageParam` = `unknown`
37​
38## Parameters
39​
40### options
41​
42`InfiniteQueryObserverOptions`\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
43​
44Infinite query options to preserve.
45​
46## Returns
47​
48`InfiniteQueryObserverOptions`\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
49​
50The same options object.
51​
52## Example
53​
54```ts
55import { infiniteQueryOptions } from '@tanstack/lit-query'
56​
57const projectsOptions = infiniteQueryOptions({
58 queryKey: ['projects'],
59 queryFn: ({ pageParam }) => fetchProjects(pageParam),
60 initialPageParam: 0,
61 getNextPageParam: (lastPage) => lastPage.nextCursor,
62})
63```