smart_query_hooks library

Classes

QueryObserver<T>

A utility interface for building observer patterns with custom state maps. Primarily used as the base subscription wrapper for useQuery.

Functions

useInfiniteQuery<TPage, TPageParam>({required List queryKey, required PagedQueryFetcher<TPage, TPageParam> fetcher, required TPageParam initialPageParam, required TPageParam? getNextPageParam(TPage lastPage, List<TPage> allPages), TPageParam? getPreviousPageParam(TPage firstPage, List<TPage> allPages)?, Duration? staleTime, Duration? cacheTime, bool enabled = true, int? retry, RetryDelayFn? retryDelay, RetryWhenFn? retryWhen}) → InfiniteQueryResult<TPage>

A hook that manages infinite scroll / "Load more" patterns.

useMutation<TData, TVariables>({required MutatorFn<TData, TVariables> mutator, int retry = 0, RetryDelayFn? retryDelay, RetryWhenFn? retryWhen, OnMutateFn<TVariables>? onMutate, OnMutationSuccessFn<TData, TVariables>? onSuccess, OnMutationErrorFn<TVariables>? onError, OnMutationSettledFn<TData, TVariables>? onSettled}) → MutationResult<TData, TVariables>

A hook that returns a mutation object to perform requests and track their state.

useQuery<T>({required List queryKey, required QueryFetcher<T> fetcher, Duration? staleTime, Duration? cacheTime, bool enabled = true, int? retry, RetryDelayFn? retryDelay, RetryWhenFn? retryWhen, bool? refetchOnWindowFocus, bool? refetchOnReconnect, Duration? refetchInterval, void onSuccess(T data, List key)?, void onError(Object error, StackTrace st, List key)?, void onSettled(T? data, Object? error)?, T? initialData, T select(T data)?, bool keepPreviousData = false}) → QueryResult<T>

A hook that subscribes to a query and returns its current state.