flutter_query library

Classes

AbortSignal
A read-only signal indicating whether an operation has been aborted.
DefaultMutationOptions
Default options applied to all mutations in a QueryClient.
DefaultQueryOptions
Default options applied to all queries in a QueryClient.
GcDuration
Controls how long unused cache data remains in memory before being garbage collected.
InfiniteData<TData, TPageParam>
Data structure for infinite queries containing pages and their params.
InfiniteQueryError<TData, TError, TPageParam>
The infinite query encountered an error.
InfiniteQueryFunctionContext<TPageParam>
Context provided to infinite query functions during execution.
InfiniteQueryOptions<TData, TError, TPageParam>
Options for configuring an infinite query.
InfiniteQueryPending<TData, TError, TPageParam>
The infinite query has no resolved data yet.
InfiniteQuerySnapshot<TData, TError, TPageParam>
A Dart-idiomatic, exhaustively matchable snapshot of an infinite query.
InfiniteQuerySuccess<TData, TError, TPageParam>
The infinite query has resolved data.
MutationError<TData, TError, TVariables>
The mutation encountered an error.
MutationFunctionContext
Context provided to mutation functions and lifecycle callbacks.
MutationIdle<TData, TError, TVariables>
The mutation has not been invoked yet.
MutationOptions<TData, TError, TVariables, TOnMutateResult>
Options for configuring a mutation.
MutationPending<TData, TError, TVariables>
The mutation is currently executing.
MutationSnapshot<TData, TError, TVariables>
A Dart-idiomatic, exhaustively matchable snapshot of a mutation's state.
MutationState<TData, TError, TVariables, TOnMutateResult>
The internal state of a mutation.
MutationSuccess<TData, TError, TVariables>
The mutation completed successfully.
Placeholder<TData>
Placeholder data shown while a query is pending and has no data, in either direct value or lazy callback form.
QueryClient
The central hub for managing cached queries and mutations.
QueryClientProvider
Provides a QueryClient to the widget tree.
QueryError<TData, TError>
The query encountered an error.
QueryFunctionContext
Context provided to query functions during execution.
QueryOptions<TData, TError>
Options for configuring a QueryObserver.
QueryPending<TData, TError>
The query has no resolved data yet.
QuerySnapshot<TData, TError>
A Dart-idiomatic, exhaustively matchable snapshot of a query's state.
QueryState<TData, TError>
The internal state of a query.
QuerySuccess<TData, TError>
The query has resolved data.
Seed<TData>
Initial data to populate a query's cache before the first fetch.
SeedUpdatedAt
The timestamp when seed data was last updated, in either direct value or lazy callback form.
StaleDuration
Controls how long query data is considered fresh before becoming stale.

Enums

FetchDirection
Direction of page fetch for infinite queries.
FetchStatus
The status of the query's fetch operation.
MutationStatus
The execution status of a mutation.
NetworkMode
Network connectivity modes for queries and mutations.
QueryStatus
The status of a query's data.
RefetchOnMount
Controls refetch behavior when an observer mounts.
RefetchOnReconnect
Controls refetch behavior when network connectivity is restored.
RefetchOnResume
Controls refetch behavior when the app resumes from background.
RefetchType
Controls which queries are refetched when calling QueryClient.invalidateQueries.

Functions

useInfiniteQuery<TData, TError, TPageParam>(List<Object?> queryKey, InfiniteQueryFn<TData, TPageParam> queryFn, {required TPageParam initialPageParam, required NextPageParamBuilder<TData, TPageParam> nextPageParamBuilder, PrevPageParamBuilder<TData, TPageParam>? prevPageParamBuilder, int? maxPages, bool? enabled, NetworkMode? networkMode, StaleDuration? staleDuration, GcDuration? gcDuration, Placeholder<InfiniteData<TData, TPageParam>>? placeholder, RefetchOnMount? refetchOnMount, RefetchOnResume? refetchOnResume, RefetchOnReconnect? refetchOnReconnect, Duration? refetchInterval, RetryResolver<TError>? retry, bool? retryOnMount, Seed<InfiniteData<TData, TPageParam>>? seed, SeedUpdatedAt? seedUpdatedAt, Map<String, dynamic>? meta, ShouldRebuild<InfiniteQuerySnapshot<TData, TError, TPageParam>>? shouldRebuild, QueryClient? client}) → InfiniteQuerySnapshot<TData, TError, TPageParam>
A hook for fetching and caching paginated data with automatic page accumulation.
useIsFetching({List<Object?>? queryKey, bool exact = false, bool predicate(List<Object?> queryKey, QueryState state)?, QueryClient? client}) → int
A hook that returns the count of queries currently fetching.
useIsMutating({List<Object?>? mutationKey, bool exact = false, bool predicate(List<Object?>? mutationKey, MutationState state)?, QueryClient? client}) → int
A hook that returns the count of mutations currently pending.
useMutation<TData, TError, TVariables, TOnMutateResult>(MutateFn<TData, TVariables> mutationFn, {MutationOnMutate<TVariables, TOnMutateResult>? onMutate, MutationOnSuccess<TData, TVariables, TOnMutateResult>? onSuccess, MutationOnError<TError, TVariables, TOnMutateResult>? onError, MutationOnSettled<TData, TError, TVariables, TOnMutateResult>? onSettled, List<Object?>? mutationKey, NetworkMode? networkMode, GcDuration? gcDuration, RetryResolver<TError>? retry, Map<String, dynamic>? meta, QueryClient? client}) → MutationSnapshot<TData, TError, TVariables>
A hook for performing create, update, and delete operations.
useMutationState({List<Object?>? mutationKey, bool exact = false, bool predicate(List<Object?>? mutationKey, MutationState state)?, QueryClient? client}) → List<MutationState>
A hook that returns mutation states from the mutation cache.
useQuery<TData, TError>(List<Object?> queryKey, QueryFn<TData> queryFn, {bool? enabled, NetworkMode? networkMode, StaleDuration? staleDuration, GcDuration? gcDuration, Placeholder<TData>? placeholder, RefetchOnMount? refetchOnMount, RefetchOnResume? refetchOnResume, RefetchOnReconnect? refetchOnReconnect, Duration? refetchInterval, RetryResolver<TError>? retry, bool? retryOnMount, Seed<TData>? seed, SeedUpdatedAt? seedUpdatedAt, Map<String, dynamic>? meta, ShouldRebuild<QuerySnapshot<TData, TError>>? shouldRebuild, QueryClient? client}) → QuerySnapshot<TData, TError>
A hook for fetching, caching, and subscribing to async data.
useQueryClient([QueryClient? client]) → QueryClient
A hook that retrieves the QueryClient from the widget tree.

Typedefs

InfiniteQueryFn<TData, TPageParam> = Future<TData> Function(InfiniteQueryFunctionContext<TPageParam> context)
Signature for the function that fetches a page of data for an infinite query.
MutateFn<TData, TVariables> = Future<TData> Function(TVariables variables, MutationFunctionContext context)
Signature for the function that performs the mutation.
MutationOnError<TError, TVariables, TOnMutateResult> = FutureOr<void> Function(TError error, TVariables variables, TOnMutateResult? onMutateResult, MutationFunctionContext context)
Signature for a callback invoked when the mutation fails.
MutationOnMutate<TVariables, TOnMutateResult> = FutureOr<TOnMutateResult?> Function(TVariables variables, MutationFunctionContext context)
Signature for a callback invoked before the mutation function executes.
MutationOnSettled<TData, TError, TVariables, TOnMutateResult> = FutureOr<void> Function(TData? data, TError? error, TVariables variables, TOnMutateResult? onMutateResult, MutationFunctionContext context)
Signature for a callback invoked when the mutation completes, regardless of outcome.
MutationOnSuccess<TData, TVariables, TOnMutateResult> = FutureOr<void> Function(TData data, TVariables variables, TOnMutateResult? onMutateResult, MutationFunctionContext context)
Signature for a callback invoked when the mutation succeeds.
NextPageParamBuilder<TData, TPageParam> = TPageParam? Function(InfiniteData<TData, TPageParam> data)
Signature for the function that determines the next page parameter.
PrevPageParamBuilder<TData, TPageParam> = TPageParam? Function(InfiniteData<TData, TPageParam> data)
Signature for the function that determines the previous page parameter.
QueryFn<TData> = Future<TData> Function(QueryFunctionContext context)
Function that fetches data for a query.
RetryResolver<TError> = Duration? Function(int retryCount, TError error)
A callback that determines whether to retry and how long to wait.
ShouldRebuild<TResult> = bool Function(TResult previous, TResult next)
Decides whether an observing widget should rebuild when a query result changes.

Exceptions / Errors

AbortedException
An exception indicating a query or mutation was aborted.