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

InfiniteQueryPageParamsOptions.md

33 lines1.9 KB

1---
2id: InfiniteQueryPageParamsOptions
3title: InfiniteQueryPageParamsOptions
4---
5​
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7​
8Defined in: [packages/query-core/src/types.ts:485](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L485)
9​
10The page param options of an infinite query: `initialPageParam`, and the `getNextPageParam` and
11`getPreviousPageParam` functions that compute the params of the pages around it.
12​
13## Extends
14​
15- [`InitialPageParam`](InitialPageParam.md)\<`TPageParam`\>
16​
17## Type Parameters
18​
19### TQueryFnData
20​
21`TQueryFnData` = `unknown`
22​
23### TPageParam
24​
25`TPageParam` = `unknown`
26​
27## Properties
28​
29| Property | Type | Description |
30| ------ | ------ | ------ |
31| <a id="property-getnextpageparam"></a> `getNextPageParam` | (`lastPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `lastPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | This function can be set to automatically get the next cursor for infinite queries. The result will also be used to determine the value of `hasNextPage`. |
32| <a id="property-getpreviouspageparam"></a> `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. |
33| <a id="property-initialpageparam"></a> `initialPageParam` | `TPageParam` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. |