TanStack
API Reference

InfiniteQueryPageParamsOptions

Defined in: packages/query-core/src/types.ts:364

Extends

Type Parameters

TQueryFnData

TQueryFnData = unknown

TPageParam

TPageParam = unknown

Properties

PropertyTypeDescription
getNextPageParam(lastPage: TQueryFnData, allPages: TQueryFnData[], lastPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | null | undefinedThis 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 | undefinedThis 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.
initialPageParamTPageParam-