Skip to content

InitialPageParam.md

Latest commit

 

History

History
26 lines (16 loc) · 995 Bytes

InitialPageParam.md

File metadata and controls

26 lines (16 loc) · 995 Bytes
Raw
id InitialPageParam
title 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

Property Type Description
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.