DefaultedQueryObserverOptions<TQueryData, TData> class final Advanced

QueryObserverOptionsBase with every default resolved: DefaultedQueryOptions plus the observer-only options, what a QueryObserver actually runs on.

Only QueryClient produces one, through QueryClient.defaultQueryObserverOptions; an observer resolves the options it is handed on construction and on every setOptions. Value equality tells the observer whether a rebuild changed anything. queryOptions is the part the shared cache entry receives.

Inheritance
Annotations
  • @immutable

Properties

behavior → FetchBehavior<TQueryData>?
QueryOptions.behavior: set for infinite queries, null otherwise.
finalinherited
enabled → Enabled
QueryOptions.enabled, with the default applied.
finalinherited
gcTime → GcTime
QueryOptions.gcTime, with the default applied.
finalinherited
hashCode → int
The hash code for this object.
no setteroverride
initialData → InitialData<TQueryData>?
QueryOptions.initialData; there is no default.
finalinherited
initialDataUpdatedAt → DateTime?
QueryOptions.initialDataUpdatedAt; there is no default.
finalinherited
initialDataUpdatedAtCompute → DateTime? Function()?
Computes the seed timestamp only when data is actually seeded. Mutually exclusive with initialDataUpdatedAt; a null result uses now.
finalinherited
meta → Object?
QueryOptions.meta, with the key's registered default applied.
finalinherited
networkMode → NetworkMode
QueryOptions.networkMode, with the default applied.
finalinherited
placeholderData → PlaceholderData<TQueryData>?
QueryObserverOptionsBase.placeholderData; there is no default.
final
queryFn → QueryFn<TQueryData>?
QueryOptions.queryFn, with the key's registered default applied. Still nullable: a query can be built without a function and fails only when it tries to fetch.
finalinherited
queryKey → QueryKey
QueryOptions.queryKey.
finalinherited
queryOptions → DefaultedQueryOptions<TQueryData>
The cache-layer view of these options — the fourteen fields a Query runs on, and none of the observer's own.
latefinal
refetchInterval → RefetchInterval
QueryObserverOptionsBase.refetchInterval, with the default applied.
final
refetchIntervalInBackground → bool
QueryObserverOptionsBase.refetchIntervalInBackground, with the default applied.
final
refetchOnMount → RefetchOn
QueryObserverOptionsBase.refetchOnMount, with the default applied.
final
refetchOnReconnect → RefetchOn
QueryObserverOptionsBase.refetchOnReconnect, with the default applied.
final
refetchOnWindowFocus → RefetchOn
QueryObserverOptionsBase.refetchOnWindowFocus, with the default applied.
final
retry → RetryPolicy
QueryOptions.retry, with the default applied.
finalinherited
retryDelay → RetryDelay
QueryOptions.retryDelay, with the default applied.
finalinherited
retryOnMount → bool
QueryObserverOptionsBase.retryOnMount, with the default applied.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
select → SelectFn<TQueryData, TData>?
QuerySelectOptions.select, or null for a QueryObserverOptions; there is no default.
final
staleTime → StaleTime
QueryOptions.staleTime, with the default applied.
finalinherited
structuralSharing → StructuralSharing<TQueryData>?
QueryOptions.structuralSharing; null still means replaceEqualDeep.
finalinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
Field-by-field equality, functions compared by identity. It is what tells a rebuild that nothing actually changed.
override