query/query library
Query system for advanced async state management
Provides React Query-like functionality with automatic caching, deduplication, and background refetching.
Classes
- QueryKey
- Utility to normalize query keys into stable strings
- ZenCancelToken
- A token that can be used to signal cancellation to async operations.
-
ZenInfiniteQuery<
T> - A specialized query for infinite scrolling / pagination.
-
ZenMutation<
TData, TVariables> - A reactive mutation that manages async data updates (creates/updates/deletes)
- ZenMutationJob
- A serialized mutation job that can be stored and replayed
- ZenMutationQueue
- Manages the offline mutation queue.
-
ZenQuery<
T> - A reactive query that manages async data fetching with caching and cancellation
-
ZenQueryBuilder<
T> - A widget that builds itself based on the state of a ZenQuery.
- ZenQueryCache
- Global cache manager for ZenQuery instances
- ZenQueryClient
- Client for managing query configuration and cache.
- ZenQueryClientOptions
- Default options for ZenQueryClient
-
ZenQueryConfig<
T> - Configuration for ZenQuery
- ZenStorage
- Interface for persisting query data.
-
ZenStreamQuery<
T> - A reactive query wrapper for Streams.
-
ZenStreamQueryBuilder<
T> - A widget that builds itself based on the state of a ZenStreamQuery.
Enums
- NetworkMode
- Network usage mode
- RefetchBehavior
- Refetch behavior for queries
- ZenMutationAction
- Action types for restoring mutations
- ZenMutationStatus
- Status of a ZenMutation
- ZenQueryFetchStatus
- Status of the network request for a query
- ZenQueryStatus
- Status of a ZenQuery
Extensions
- RefetchBehaviorX on RefetchBehavior
- Extension methods for RefetchBehavior
Typedefs
- RetryDelayFn = Duration Function(int attempt, Object error)
- Function signature for dynamic retry delay calculation
-
ZenMutationHandler
= Future Function(Map<
String, dynamic> payload) - Handler function for replaying mutations
-
ZenQueryFetcher<
T> = Future< T> Function(ZenCancelToken cancelToken) - Function signature for data fetching with cancellation support
Exceptions / Errors
- ZenCancellationException
- Exception thrown when an operation is cancelled
- ZenOfflineException
- Exception thrown when a query cannot proceed due to offline network status