riverpod_annotation library

Classes

AsyncData<T>
Creates an AsyncValue with a data.
AsyncError<T>
Creates an AsyncValue in the error state.
AsyncLoading<T>
Creates an AsyncValue in loading state.
AsyncNotifier<State>
A Notifier implementation that is asynchronously initialized.
AsyncNotifierProviderElement<NotifierT extends AsyncNotifierBase<T>, T>
The element of AsyncNotifierProvider.
AsyncNotifierProviderImpl<NotifierT extends AsyncNotifierBase<T>, T>
The implementation of AsyncNotifierProvider but with loosened type constraints that can be shared with AutoDisposeAsyncNotifierProvider.
AsyncNotifierProviderRef<T>
An object used by providers to interact with other providers and the life-cycles of the application.
AsyncValue<T>
A utility for safely manipulating asynchronous data.
AutoDisposeAsyncNotifier<State>
A Notifier implementation that is asynchronously initialized.
AutoDisposeAsyncNotifierProviderElement<NotifierT extends AsyncNotifierBase<T>, T>
The element of AutoDisposeAsyncNotifierProvider.
AutoDisposeAsyncNotifierProviderImpl<NotifierT extends AsyncNotifierBase<T>, T>
The implementation of AutoDisposeAsyncNotifierProvider but with loosened type constraints that can be shared with AsyncNotifierProvider.
AutoDisposeAsyncNotifierProviderRef<T>
An object used by providers to interact with other providers and the life-cycles of the application.
AutoDisposeFutureProvider<T>
A provider that asynchronously creates a single value.
AutoDisposeFutureProviderElement<T>
The ProviderElementBase of AutoDisposeFutureProvider
AutoDisposeFutureProviderFamily<R, Arg>
The Family of an AutoDisposeFutureProvider
AutoDisposeFutureProviderRef<State>
An object used by providers to interact with other providers and the life-cycles of the application.
AutoDisposeNotifier<State>
{@template riverpod.notifier}
AutoDisposeNotifierProviderElement<NotifierT extends NotifierBase<T>, T>
The element of AutoDisposeNotifierProvider
AutoDisposeNotifierProviderImpl<NotifierT extends NotifierBase<T>, T>
The implementation of AutoDisposeNotifierProvider but with loosened type constraints that can be shared with NotifierProvider.
AutoDisposeNotifierProviderRef<T>
An object used by providers to interact with other providers and the life-cycles of the application.
AutoDisposeProvider<T>
A provider that exposes a read-only value.
AutoDisposeProviderElement<T>
The element of AutoDisposeProvider
AutoDisposeProviderFamily<R, Arg>
The Family of AutoDisposeProvider
AutoDisposeProviderRef<State>
An object used by providers to interact with other providers and the life-cycles of the application.
BuildlessAsyncNotifier<State>
A AsyncNotifier base class shared between family and non-family notifiers.
BuildlessAutoDisposeAsyncNotifier<State>
A AutoDisposeAsyncNotifier base class shared between family and non-family notifiers.
BuildlessAutoDisposeNotifier<State>
An AutoDisposeNotifier base class shared between family and non-family notifiers.
BuildlessNotifier<State>
A Notifier base class shared between family and non-family notifiers.
Family<State>
A base class for all families
FutureOr<T>
A type representing values that are either Future<T> or T.
FutureProvider<T>
A provider that asynchronously creates a single value.
FutureProviderElement<T>
The element of a FutureProvider
FutureProviderFamily<R, Arg>
The Family of a FutureProvider
FutureProviderRef<State>
An object used by providers to interact with other providers and the life-cycles of the application.
Notifier<State>
A class which exposes a state that can change over time.
NotifierProviderElement<NotifierT extends NotifierBase<T>, T>
The element of NotifierProvider.
NotifierProviderImpl<NotifierT extends NotifierBase<T>, T>
The implementation of NotifierProvider but with loosened type constraints that can be shared with AutoDisposeNotifierProvider.
NotifierProviderRef<T>
An object used by providers to interact with other providers and the life-cycles of the application.
Provider<State>
A provider that exposes a read-only value.
ProviderElement<State>
A provider that exposes a read-only value.
ProviderFamily<R, Arg>
The Family of Provider
ProviderFor
An annotation used to help the linter find the user-defined element from the generated provider.
ProviderOrFamily
A common interface shared by ProviderBase and Family
ProviderRef<State>
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

AsyncValueX on AsyncValue<T>
An extension that adds methods like when to an AsyncValue.

Constants

riverpod → const Riverpod
An annotation placed on classes or functions.

Typedefs

AsyncNotifierProvider<NotifierT extends AsyncNotifier<T>, T> = AsyncNotifierProviderImpl<NotifierT, T>
AutoDisposeAsyncNotifierProvider<NotifierT extends AutoDisposeAsyncNotifier<T>, T> = AutoDisposeAsyncNotifierProviderImpl<NotifierT, T>
A Notifier implementation that is asynchronously initialized.
AutoDisposeNotifierProvider<NotifierT extends AutoDisposeNotifier<T>, T> = AutoDisposeNotifierProviderImpl<NotifierT, T>
A class which exposes a state that can change over time.
NotifierProvider<NotifierT extends Notifier<T>, T> = NotifierProviderImpl<NotifierT, T>
A Provider which exposes a Notifier and listens to it.