Skip to main content

InitialPageParam

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

Holds the initialPageParam option that every infinite query requires.

Extended by

Type Parameters

TPageParam

TPageParam = unknown

Properties

PropertyTypeDescription
initialPageParamTPageParamThe 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.
Edit on GitHub