0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/react/reference/interfaces/UseSuspenseQueryOptions.md
Wonsuk Choi 4c568a28c8
docs(react-query): generate reference docs with TypeDoc (#11366)
* docs(vue-query,solid-query): inline react reference content instead of 'ref'-ing hand-written react docs

* docs(react-query): generate reference docs with TypeDoc

* docs(vue-query,solid-query): fix dangling suspense-hook links left over from the react content copy

* docs(solid-query): apply solid's callback call form to inlined reference examples

* docs(react-query): correct inaccurate JSDoc statements flagged in review

* docs(vue-query,solid-query): fix reactivity-aware examples and inaccurate type signatures flagged in review

* docs(vue-query,solid-query): fix remaining type/behavior inaccuracies flagged in second review

* docs(react-query): stop implying a default queryFn defers a fetch the way 'enabled: false' does

* docs(vue-query): mark 'mutate'/'mutateAsync' per-call options as optional
2026-09-02 16:06:54 +09:00

1.8 KiB

id title
UseSuspenseQueryOptions UseSuspenseQueryOptions

Defined in: react-query/src/types.ts:196

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

Extends

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

Type Parameters

TQueryFnData

TQueryFnData = unknown

The type your queryFn resolves to.

TError

TError = DefaultError

The type of errors your queryFn may throw.

TData

TData = TQueryFnData

The type data ends up as after select runs. Defaults to TQueryFnData when no select is used.

TQueryKey

TQueryKey extends QueryKey = QueryKey

The type of your queryKey.

Properties

queryFn?

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

Defined in: react-query/src/types.ts:209

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: react-query/src/types.ts:65

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

Default Value

true

Inherited from

OmitKeyof.subscribed