Interface InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam>

interface InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam> {
    getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>;
    getPreviousPageParam?: GetPreviousPageParamFunction<TPageParam, TQueryFnData>;
    initialPageParam: TPageParam;
}

Type Parameters

  • TQueryFnData = unknown
  • TPageParam = unknown

Hierarchy (view full)

Properties

getNextPageParam getPreviousPageParam? initialPageParam

Properties

getNextPageParam

getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>

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.

OptionalgetPreviousPageParam

getPreviousPageParam?: GetPreviousPageParamFunction<TPageParam, TQueryFnData>

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

Settings

Member Visibility

On This Page

Properties