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/UseBaseQueryOptions.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.4 KiB

id title
UseBaseQueryOptions UseBaseQueryOptions

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

The options shared by useQuery and useSuspenseQuery. Extends QueryObserverOptions from @tanstack/query-core with the react-query-specific subscribed option.

Extends

  • QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

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.

TQueryData

TQueryData = TQueryFnData

The type of the data actually held in the query cache — the input to select and placeholderData. Defaults to, and is usually the same as, TQueryFnData.

TQueryKey

TQueryKey extends QueryKey = QueryKey

The type of your queryKey.

Properties

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