cached_query_flutter library

Classes

CachedQuery
CachedQuery is a singleton that keeps track of all the cached queries
InfiniteQuery<T, A>
InfiniteQuery caches a series of Query's for use in an infinite list.
InfiniteQueryBuilder<T, A>
Listen to changed in an InfiniteQuery and build the ui with the result.
InfiniteQueryState<T>
InfiniteQueryState holds the current state of an InfiniteQuery
Mutation<T, A>
{@template mutation} Mutation is used to create, update and delete data from an asynchronous source.
MutationBuilder<T, A>
Called on each widget build.
MutationState<T>
MutationState holds the current state of an InfiniteQuery.
Query<T>
Query is will fetch and cache the response of the queryFn.
QueryBase<T, State extends QueryState>
An Interface for both Query and InfiniteQuery.
QueryBuilder<T>
Listen to changes in an Mutation and build the ui with the result.
QueryConfig
Global config for all queries and infinite queries.
QueryConfigFlutter
Query config including flutter options
QueryObserver
Query Observer
QueryState<T>
QueryState holds the current state of a Query
StateBase
An Interface for both QueryState and InfiniteQueryState.
StorageInterface
An interface for any storage adapter.

Extensions

CachedQueryExt
Flutter specific extension on CachedQuery

Enums

QueryStatus
Generic status of a query or mutation.
RefetchReason
The reason the cache is being refetched.

Typedefs

GetNextArg<T, A> = A? Function(InfiniteQueryState<T>)
Determines the parameters of the next page in an infinite query.
InfiniteQueryBuilderCondition<T> = FutureOr<bool> Function(InfiniteQueryState<T> oldState, InfiniteQueryState<T> newState)
This function is being called everytime the query registered in the InfiniteQueryBuilder receives new updates and let's you control when the _InfiniteQueryBuilderState.build method should be called
InfiniteQueryBuilderFunc<T, A> = Widget Function(BuildContext context, InfiniteQueryState<T> state, InfiniteQuery<T, A> query)
The builder function is called on each widget build.
InfiniteQueryFunc<T, A> = Future<T> Function(A)
The result of the InfiniteQueryFunc will be cached.
KeyFilterFunc = bool Function(Object unencodedKey, String key)
Used to match multiple queries.
MutationBuilderCallback<T, A> = Widget Function(BuildContext context, MutationState<T> state, Future<T?> mutate(A args))
Called on each widget build.
MutationBuilderCondition<T> = FutureOr<bool> Function(MutationState<T> oldState, MutationState<T> newState)
This function is being called everytime the query registered in the MutationBuilder receives new updates and let's you control when the _MutationBuilderState.build method should be called
MutationQueryCallback<T, A> = Future<T> Function(A arg)
The asynchronous query function.
OnErrorCallback<A> = FutureOr<void> Function(A arg, Object error, Object? fallback)
Called when the queryFn as completed with an error.
OnInfiniteQueryErrorCallback<T> = void Function(dynamic)
On success is called when the query function is executed successfully.
OnInfiniteQuerySuccessCallback<T> = void Function(T)
On success is called when the query function is executed successfully.
OnQueryErrorCallback<T> = void Function(dynamic)
On success is called when the query function is executed successfully.
OnQuerySuccessCallback<T> = void Function(T)
On success is called when the query function is executed successfully.
OnStartMutateCallback<A> = FutureOr Function(A arg)
Called when Mutation has started.
OnSuccessCallback<T, A> = FutureOr<void> Function(T res, A arg)
Called when the queryFn as completed with no error.
QueryBuilderCondition<T> = FutureOr<bool> Function(QueryState<T> oldState, QueryState<T> newState)
This function is being called everytime the query registered in the QueryBuilder receives new updates and let's you control when the _QueryBuilderState.build method should be called
QueryFunc<T> = Future<T> Function()
The result of the QueryFunc will be cached.
Serializer = dynamic Function(dynamic json)
Used to serialize the query data when fetched from local storage.
UpdateFunc<T> = T? Function(T? oldData)
Update function used to update the data in a query.
WhereCallback = bool Function(QueryBase)
Should return true if a condition is met.