Function: injectInfiniteQuery()#
Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key. Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"
Param#
A function that returns infinite query options.
Param#
Additional configuration.
Call Signature#
function injectInfiniteQuery<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam,
>(
injectInfiniteQueryFn,
options?,
): DefinedCreateInfiniteQueryResult<TData, TError>
Defined in: inject-infinite-query.ts:41
Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key. Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"
Type Parameters#
• TQueryFnData
• TError = Error
• TData = InfiniteData<TQueryFnData, unknown>
• TQueryKey extends readonly unknown[] = readonly unknown[]
• TPageParam = unknown
Parameters#
injectInfiniteQueryFn#
() => DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
A function that returns infinite query options.
options?#
Additional configuration.
Returns#
DefinedCreateInfiniteQueryResult<TData, TError>
The infinite query result.
The infinite query result.
Param#
A function that returns infinite query options.
Param#
Additional configuration.
Call Signature#
function injectInfiniteQuery<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam,
>(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>
Defined in: inject-infinite-query.ts:65
Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key. Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"
Type Parameters#
• TQueryFnData
• TError = Error
• TData = InfiniteData<TQueryFnData, unknown>
• TQueryKey extends readonly unknown[] = readonly unknown[]
• TPageParam = unknown
Parameters#
injectInfiniteQueryFn#
() => UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
A function that returns infinite query options.
options?#
Additional configuration.
Returns#
CreateInfiniteQueryResult<TData, TError>
The infinite query result.
The infinite query result.
Param#
A function that returns infinite query options.
Param#
Additional configuration.
Call Signature#
function injectInfiniteQuery<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam,
>(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>
Defined in: inject-infinite-query.ts:89
Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key. Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"
Type Parameters#
• TQueryFnData
• TError = Error
• TData = InfiniteData<TQueryFnData, unknown>
• TQueryKey extends readonly unknown[] = readonly unknown[]
• TPageParam = unknown
Parameters#
injectInfiniteQueryFn#
() => CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
A function that returns infinite query options.
options?#
Additional configuration.
Returns#
CreateInfiniteQueryResult<TData, TError>
The infinite query result.
The infinite query result.
Param#
A function that returns infinite query options.
Param#
Additional configuration.