API Documentation / @pinia/colada / useInfiniteQuery
Function: useInfiniteQuery()
Call Signature
function useInfiniteQuery<TData, TError, TPageParam, TDataInitial>(options): UseInfiniteQueryReturn<TData, TError, TPageParam, TDataInitial>;Store and merge paginated data into a single cache entry. Allows to handle infinite scrolling.
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.
Returns
UseInfiniteQueryReturn<TData, TError, TPageParam, TDataInitial>
Call Signature
function useInfiniteQuery<TData, TError, TPageParam, TDataInitial>(options): UseInfiniteQueryReturn<TData, TError, TPageParam, TDataInitial>;Store and merge paginated data into a single cache entry. Allows to handle infinite scrolling. Accepts a getter returning options defined with defineInfiniteQueryOptions.
Type Parameters
TData
TData
TError
TError = { custom: Error; }
TPageParam
TPageParam = unknown
TDataInitial
TDataInitial extends | UseInfiniteQueryData<TData, TPageParam> | undefined = undefined
Parameters
options
() => DefineInfiniteQueryOptions<TData, TError, TPageParam, TDataInitial>
A getter that returns the infinite query options.
Returns
UseInfiniteQueryReturn<TData, TError, TPageParam, TDataInitial>