API Reference

infiniteQueryOptions

Function: infiniteQueryOptions()

Call Signature

ts
function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object & object;

Defined in: preact-query/src/infiniteQueryOptions.ts:75

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`\>

Returns

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

Call Signature

ts
function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): OmitKeyof<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, "queryFn"> & object & object;

Defined in: preact-query/src/infiniteQueryOptions.ts:99

Type Parameters

TQueryFnData

TQueryFnData

TError

TError = Error

TData

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

TQueryKey

TQueryKey extends readonly unknown[] = readonly unknown[]

TPageParam

TPageParam = unknown

Parameters

options

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

Returns

OmitKeyof\<[`UseInfiniteQueryOptions`](../interfaces/UseInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>, "queryFn"> & object & object

Call Signature

ts
function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object & object;

Defined in: preact-query/src/infiniteQueryOptions.ts:123

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`\>

Returns

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