0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/preact/reference/interfaces/UseQueryOptions.md

1.3 KiB

id title
UseQueryOptions UseQueryOptions

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

The options accepted by useQuery. Same as UseBaseQueryOptions, minus suspense (which preact-query derives from which hook you call rather than exposing as an option).

Extends

  • OmitKeyof<UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, "suspense">

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

subscribed?

optional subscribed: boolean;

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

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

Default Value

true

Inherited from

OmitKeyof.subscribed