id: infiniteQueryOptions
title: infiniteQueryOptions
Function: infiniteQueryOptions()
Allows to share and re-use infinite query options in a type-safe way.
The queryKey will be tagged with the type from queryFn.
Param
The infinite query options to tag with the type from queryFn.
Call Signature
function infiniteQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam,
>(
options,
): DefinedInitialDataInfiniteOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam
> &
object
Allows to share and re-use infinite query options in a type-safe way.
The queryKey will be tagged with the type from queryFn.
Type Parameters
• TQueryFnData
• TError = Error
• TData = InfiniteData<TQueryFnData, unknown>
• TQueryKey extends readonly unknown[] = readonly unknown[]
• TPageParam = unknown
Parameters
options
DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
The infinite query options to tag with the type from queryFn.
Returns
DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object
The tagged infinite query options.
The tagged infinite query options.
Param
The infinite query options to tag with the type from queryFn.
Defined in
Call Signature
function infiniteQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam,
>(
options,
): UnusedSkipTokenInfiniteOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam
> &
object
Allows to share and re-use infinite query options in a type-safe way.
The queryKey will be tagged with the type from queryFn.
Type Parameters
• TQueryFnData
• TError = Error
• TData = InfiniteData<TQueryFnData, unknown>
• TQueryKey extends readonly unknown[] = readonly unknown[]
• TPageParam = unknown
Parameters
options
UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
The infinite query options to tag with the type from queryFn.
Returns
UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object
The tagged infinite query options.
The tagged infinite query options.
Param
The infinite query options to tag with the type from queryFn.
Defined in
Call Signature
function infiniteQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam,
>(
options,
): UndefinedInitialDataInfiniteOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam
> &
object
Allows to share and re-use infinite query options in a type-safe way.
The queryKey will be tagged with the type from queryFn.
Type Parameters
• TQueryFnData
• TError = Error
• TData = InfiniteData<TQueryFnData, unknown>
• TQueryKey extends readonly unknown[] = readonly unknown[]
• TPageParam = unknown
Parameters
options
UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
The infinite query options to tag with the type from queryFn.
Returns
UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object
The tagged infinite query options.
The tagged infinite query options.
Param
The infinite query options to tag with the type from queryFn.