upstream-tanstack-query/docs/framework/lit/reference/interfaces/InfiniteQueryPageParamsOptions.md

id, title

id	title
InfiniteQueryPageParamsOptions	InfiniteQueryPageParamsOptions

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

Extends

• InitialPageParam<TPageParam>

Extended by

• InfiniteQueryObserverOptions

Type Parameters

TQueryFnData

TQueryFnData = unknown

TPageParam

TPageParam = unknown

Properties

getNextPageParam

getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>;

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

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?

optional getPreviousPageParam: GetPreviousPageParamFunction<TPageParam, TQueryFnData>;

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

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

initialPageParam: TPageParam;

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

Inherited from

InitialPageParam.initialPageParam