UseSuspenseInfiniteQueryOptions

Defined in: preact-query/src/types.ts:279

The options accepted by useSuspenseInfiniteQuery. Same as UseInfiniteQueryOptions, minus enabled, throwOnError, and placeholderData — Suspense hooks cannot render a "disabled" or "placeholder" state, so those options don't apply.

Extends#

• OmitKeyof<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, "queryFn" | "enabled" | "throwOnError" | "placeholderData">

Type Parameters#

TQueryFnData#

TQueryFnData = unknown

The type of a single page, as your queryFn resolves it.

TError#

TError = DefaultError

The type of errors your queryFn may throw.

TData#

TData = InfiniteData<TQueryFnData>

The type data ends up as after select runs — defaults to InfiniteData<TQueryFnData>, the shape of all fetched pages plus their page params.

TQueryKey#

TQueryKey extends QueryKey = QueryKey

The type of your queryKey.

TPageParam#

TPageParam = unknown

The type of the parameter passed to queryFn to fetch a given page.

Properties#

queryFn?#

optional queryFn: QueryFunction<TQueryFnData, TQueryKey, TPageParam>;

Defined in: preact-query/src/types.ts:293

skipToken is not allowed here — Suspense hooks cannot render a "disabled" state, so a query function must always be provided, unless a default query function has been defined.

subscribed?#

optional subscribed: boolean;

Defined in: preact-query/src/types.ts:258

Set this to false to unsubscribe this observer from updates to the query cache.

Default Value#

true

Inherited from#

OmitKeyof.subscribed