riverpod_annotation library

Classes

$ProviderOverride
An object used by ProviderContainer to override the behavior of a provider for a part of the application.
$StreamNotifierProvider<NotifierT extends $StreamNotifier<ValueT>, ValueT>
Implementation detail of riverpod_generator. Do not use.
AnyNotifier<StateT, ValueT> Notifiers
A base class for all "notifiers".
AsyncData<ValueT> Core
Creates an AsyncValue with a data.
AsyncError<ValueT> Core
Creates an AsyncValue in the error state.
AsyncLoading<ValueT> Core
Creates an AsyncValue in loading state.
AsyncResult<ValueT>
A variant of AsyncValue that excludes AsyncLoading.
AsyncValue<ValueT> Core
A utility for safely manipulating asynchronous data.
FutureOr<T>
A type representing values that are either Future<T> or T.
Override
An object used by ProviderContainer/ProviderScope to override the behavior of a provider/family for part of the application.
ProviderContainer Core
An object that stores the state of the providers and allows overriding the behavior of a specific provider.
ProviderFor
An annotation used to help the linter find the user-defined element from the generated provider.
ProviderListenable<StateT>
A base class for all providers, used to consume a provider.
ProviderOrFamily
A common interface shared by ProviderBase and Family
Ref Core
An object used by providers to interact with other providers and the life-cycles of the application.
Riverpod
An annotation placed on classes or functions.

Extensions

AsyncValueExtensions on AsyncValue<ValueT>
Adds non-state related methods/getters to AsyncValue.

Constants

$internal → const Object
An implementation detail of riverpod_generator. Do not use.
$mustCallSuper → const Object
An implementation detail of riverpod_generator. Do not use.
riverpod → const Riverpod
An annotation placed on classes or functions.

Typedefs

Raw<WrappedT> = WrappedT
An annotation for marking a value type as "should not be handled by Riverpod".
WhenComplete = void Function(void cb())?
A Future-like that support synchronous completion.

Exceptions / Errors

MissingScopeException
An exception thrown when a scoped provider is accessed when not yet overridden.