| id |
InfiniteQueryPageParamsOptions |
| title |
InfiniteQueryPageParamsOptions |
Defined in: packages/query-core/src/types.ts:485
The page param options of an infinite query: initialPageParam, and the getNextPageParam and
getPreviousPageParam functions that compute the params of the pages around it.
TQueryFnData = unknown
TPageParam = unknown
| Property |
Type |
Description |
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. |
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. |
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. |