InfiniteQueryPageParamsOptions
定义位置:packages/query-core/src/types.ts:485
无限查询(infinite query)的分页参数选项:initialPageParam,以及用于计算其相邻页面参数的 getNextPageParam 和 getPreviousPageParam 函数。
继承自
类型参数
TQueryFnData
TQueryFnData = unknown
TPageParam
TPageParam = unknown
属性
| 属性 |
类型 |
描述 |
getNextPageParam |
(lastPage: TQueryFnData, allPages: TQueryFnData[], lastPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | null | undefined |
此函数可用于自动获取无限查询的下一页游标(cursor)。该函数的返回值还将用于确定 hasNextPage 的值。 |
getPreviousPageParam? |
(firstPage: TQueryFnData, allPages: TQueryFnData[], firstPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | null | undefined |
此函数可用于自动获取无限查询的上一页游标(cursor)。该函数的返回值还将用于确定 hasPreviousPage 的值。 |
initialPageParam |
TPageParam |
当无限查询尚无任何页面时,用作起始分页参数(page param)的值。它将作为 pageParam 传入 queryFn 以获取第一页;此后每一页的参数则由 getNextPageParam 或 getPreviousPageParam 返回的值决定。该参数仅在查询尚未拥有任何页面时生效:一旦已存在第一页,重新拉取(refetch)将从该页自身的参数开始。 |