API Documentation / @pinia/colada / useInfiniteQuery
Function: useInfiniteQuery()
ts
function useInfiniteQuery<TData, TError, TPageParam, TDataInitial>(options): UseInfiniteQueryReturn<TData, TError, TPageParam, TDataInitial>;Experimental
Store and merge paginated data into a single cache entry. Allows to handle infinite scrolling. This is an experimental API and is subject to change.
Type Parameters
TData
TData
TError
TError = { custom: Error; }
TPageParam
TPageParam = unknown
TDataInitial
TDataInitial extends | UseInfiniteQueryData<TData, TPageParam> | undefined = undefined
Parameters
options
UseInfiniteQueryOptions<TData, TError, TPageParam, TDataInitial>
Options to configure the infinite query.
See https://github.com/posva/pinia-colada/issues/178
Returns
UseInfiniteQueryReturn<TData, TError, TPageParam, TDataInitial>