Class QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>

Type Parameters

TQueryFnData = unknown
TError = DefaultError
TData = TQueryFnData
TQueryData = TQueryFnData
TQueryKey extends QueryKey = QueryKey

Hierarchy (view full)

Subscribable<QueryObserverListener<TData, TError>>
- QueryObserver
  - InfiniteQueryObserver

Constructors

constructor

new QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>(client, options): QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>
Type Parameters
- TQueryFnData = unknown
- TError = Error
- TData = TQueryFnData
- TQueryData = TQueryFnData
- TQueryKey extends QueryKey = QueryKey
Parameters
- client: QueryClient
- options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, never>
Returns QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>
Overrides Subscribable<QueryObserverListener<TData, TError>>.constructor
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:726

Properties

`Private` #private

#private: any

`Protected` listeners

listeners: Set<QueryObserverListener<TData, TError>>

options

options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, never>

Methods

`Protected` bindMethods

bindMethods(): void
Returns void
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:727

`Protected` createResult

createResult(query, options): QueryObserverResult<TData, TError>
Parameters
- query: Query<TQueryFnData, TError, TQueryData, TQueryKey>
- options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, never>
Returns QueryObserverResult<TData, TError>
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:741

destroy

destroy(): void
Returns void
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:732

`Protected` fetch

fetch(fetchOptions): Promise<QueryObserverResult<TData, TError>>
Parameters
- fetchOptions: ObserverFetchOptions
Returns Promise<QueryObserverResult<TData, TError>>
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:740

fetchOptimistic

fetchOptimistic(options): Promise<QueryObserverResult<TData, TError>>
Parameters
- options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, never>
Returns Promise<QueryObserverResult<TData, TError>>
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:739

getCurrentQuery

getCurrentQuery(): Query<TQueryFnData, TError, TQueryData, TQueryKey>
Returns Query<TQueryFnData, TError, TQueryData, TQueryKey>
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:737

getCurrentResult

getCurrentResult(): QueryObserverResult<TData, TError>
Returns QueryObserverResult<TData, TError>
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:735

getOptimisticResult

getOptimisticResult(options): QueryObserverResult<TData, TError>
Parameters
- options: DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
Returns QueryObserverResult<TData, TError>
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:734

hasListeners

hasListeners(): boolean
Returns boolean
Inherited from Subscribable.hasListeners
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/subscribable.d.ts:6

onQueryUpdate

onQueryUpdate(): void
Returns void
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:743

`Protected` onSubscribe

onSubscribe(): void
Returns void
Overrides Subscribable.onSubscribe
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:728

`Protected` onUnsubscribe

onUnsubscribe(): void
Returns void
Overrides Subscribable.onUnsubscribe
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:729

refetch

refetch(__namedParameters?): Promise<QueryObserverResult<TData, TError>>
Parameters
- Optional __namedParameters: RefetchOptions
Returns Promise<QueryObserverResult<TData, TError>>
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:738

setOptions

setOptions(options?, notifyOptions?): void
Parameters
- Optional options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, never>
- Optional notifyOptions: NotifyOptions
Returns void
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:733

shouldFetchOnReconnect

shouldFetchOnReconnect(): boolean
Returns boolean
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:730

shouldFetchOnWindowFocus

shouldFetchOnWindowFocus(): boolean
Returns boolean
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:731

subscribe(listener): (() => void)
Parameters
- listener: QueryObserverListener<TData, TError>
Returns (() => void)
- - (): void
  - Returns void
Inherited from Subscribable.subscribe
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/subscribable.d.ts:5

trackResult

trackResult(result): QueryObserverResult<TData, TError>
Parameters
- result: QueryObserverResult<TData, TError>
Returns QueryObserverResult<TData, TError>
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:736

updateResult

updateResult(notifyOptions?): void
Parameters
- Optional notifyOptions: NotifyOptions
Returns void
- Defined in node_modules/.pnpm/@tanstack+query-core@5.17.19/node_modules/@tanstack/query-core/build/modern/queryClient-aPcvMwE9.d.ts:742

Class QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>

Type Parameters

TQueryFnData = unknown

TError = DefaultError

TData = TQueryFnData

TQueryData = TQueryFnData

TQueryKey extends QueryKey = QueryKey

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

TQueryFnData = unknown

TError = Error

TData = TQueryFnData

TQueryData = TQueryFnData

TQueryKey extends QueryKey = QueryKey

Parameters

client: QueryClient

options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, never>

Returns QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>

Properties

Private #private

Protected listeners

options

Methods

Protected bindMethods

Returns void

Protected createResult

Parameters

query: Query<TQueryFnData, TError, TQueryData, TQueryKey>

options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, never>

Returns QueryObserverResult<TData, TError>

destroy

Returns void

Protected fetch

Parameters

fetchOptions: ObserverFetchOptions

Returns Promise<QueryObserverResult<TData, TError>>

fetchOptimistic

Parameters

options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, never>

Returns Promise<QueryObserverResult<TData, TError>>

getCurrentQuery

Returns Query<TQueryFnData, TError, TQueryData, TQueryKey>

getCurrentResult

Returns QueryObserverResult<TData, TError>

getOptimisticResult

Parameters

options: DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

Returns QueryObserverResult<TData, TError>

hasListeners

Returns boolean

onQueryUpdate

Returns void

Protected onSubscribe

Returns void

Protected onUnsubscribe

Returns void

refetch

Parameters

Optional __namedParameters: RefetchOptions

Returns Promise<QueryObserverResult<TData, TError>>

setOptions

Parameters

Optional options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, never>

Optional notifyOptions: NotifyOptions

Returns void

shouldFetchOnReconnect

Returns boolean

shouldFetchOnWindowFocus

Returns boolean

subscribe

Parameters

listener: QueryObserverListener<TData, TError>

Returns (() => void)

Returns void

`Private` #private

`Protected` listeners

`Protected` bindMethods

`Protected` createResult

`Protected` fetch

`Protected` onSubscribe

`Protected` onUnsubscribe

`Optional` __namedParameters: RefetchOptions

`Optional` options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, never>

`Optional` notifyOptions: NotifyOptions

`Optional` notifyOptions: NotifyOptions