API Reference

useInfiniteQuery

Function: useInfiniteQuery()

Call Signature

ts
function useInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options, queryClient?): DefinedUseInfiniteQueryResult<TData, TError>;

Defined in: preact-query/src/useInfiniteQuery.ts:20

Type Parameters

TQueryFnData

TQueryFnData

TError

TError = Error

TData

TData = InfiniteData\<`TQueryFnData`, `unknown`\>

TQueryKey

TQueryKey extends readonly unknown[] = readonly unknown[]

TPageParam

TPageParam = unknown

Parameters

options

DefinedInitialDataInfiniteOptions\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>

queryClient?

QueryClient

Returns

DefinedUseInfiniteQueryResult\<`TData`, `TError`\>

Call Signature

ts
function useInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options, queryClient?): UseInfiniteQueryResult<TData, TError>;

Defined in: preact-query/src/useInfiniteQuery.ts:37

Type Parameters

TQueryFnData

TQueryFnData

TError

TError = Error

TData

TData = InfiniteData\<`TQueryFnData`, `unknown`\>

TQueryKey

TQueryKey extends readonly unknown[] = readonly unknown[]

TPageParam

TPageParam = unknown

Parameters

options

UndefinedInitialDataInfiniteOptions\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>

queryClient?

QueryClient

Returns

UseInfiniteQueryResult\<`TData`, `TError`\>

Call Signature

ts
function useInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options, queryClient?): UseInfiniteQueryResult<TData, TError>;

Defined in: preact-query/src/useInfiniteQuery.ts:54

Type Parameters

TQueryFnData

TQueryFnData

TError

TError = Error

TData

TData = InfiniteData\<`TQueryFnData`, `unknown`\>

TQueryKey

TQueryKey extends readonly unknown[] = readonly unknown[]

TPageParam

TPageParam = unknown

Parameters

options

UseInfiniteQueryOptions\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>

queryClient?

QueryClient

Returns

UseInfiniteQueryResult\<`TData`, `TError`\>