VoltQuery<T> class

A query with a declarative data fetching and caching API

This is used to define a query that will be run to get data, and then cache that data

Constructors

VoltQuery({required List<String?> queryKey, required Future queryFn()?, required T select(dynamic data), Duration? staleDuration, bool useComputeIsolate = false, bool disableDiskCache = false, String? scope, Duration? pollingDuration})
const

Properties

disableDiskCache → bool
Disables the disk cache for this query
final
hashCode → int
The hash code for this object.
no setterinherited
pollingDuration → Duration?
The duration to poll the query for
final
queryFn → Future Function()?
The function to run the query
final
queryKey → List<String?>
The key to use for the query
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scope → String?
The scope to use for the query
final
select → T Function(dynamic data)
The function to select the data from the query
final
staleDuration → Duration?
The time to keep the data in the cache before it is considered stale
final
useComputeIsolate → bool
For extremely large queries run select in a compute isolate
final

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
The equality operator.
inherited