Added AsyncNotifier.listenSelf

fixes #3795
rrousselGit · Oct 22, 2024 · 54bed92 · 54bed92
1 parent 2876c7f
commit 54bed92
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 0 deletions.
diff --git a/packages/flutter_riverpod/CHANGELOG.md b/packages/flutter_riverpod/CHANGELOG.md
@@ -1,3 +1,7 @@
+## Unreleased 2.6.1
+
+- Added `AsyncNotifier.listenSelf`. It was mistakenly absent from the 2.6.0 release
+
 ## 2.6.0 - 2024-10-20
 
 - Deprecated all `Ref` subclasses. Instead, use `Ref` itself.

diff --git a/packages/hooks_riverpod/CHANGELOG.md b/packages/hooks_riverpod/CHANGELOG.md
@@ -1,3 +1,7 @@
+## Unreleased 2.6.1
+
+- Added `AsyncNotifier.listenSelf`. It was mistakenly absent from the 2.6.0 release
+
 ## 2.6.0 - 2024-10-20
 
 - Deprecated all `Ref` subclasses. Instead, use `Ref` itself.

diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md
@@ -1,3 +1,7 @@
+## Unreleased 2.6.1
+
+- Added `AsyncNotifier.listenSelf`. It was mistakenly absent from the 2.6.0 release
+
 ## 2.6.0 - 2024-10-20
 
 - Deprecated all `Ref` subclasses. Instead, use `Ref` itself.

diff --git a/packages/riverpod/lib/src/async_notifier.dart b/packages/riverpod/lib/src/async_notifier.dart
@@ -33,6 +33,15 @@ abstract class AsyncNotifierBase<State> {
 
   void _setElement(ProviderElementBase<AsyncValue<State>> element);
 
+  /// {@macro notifier.listen}
+  void listenSelf(
+    void Function(AsyncValue<State>? previous, AsyncValue<State> next)
+        listener, {
+    void Function(Object error, StackTrace stackTrace)? onError,
+  }) {
+    _element.listenSelf(listener, onError: onError);
+  }
+
   /// The value currently exposed by this [AsyncNotifier].
   ///
   /// Defaults to [AsyncLoading] inside the [AsyncNotifier.build] method.

diff --git a/packages/riverpod/lib/src/notifier.dart b/packages/riverpod/lib/src/notifier.dart
@@ -21,13 +21,15 @@ abstract class NotifierBase<State> {
 
   void _setElement(ProviderElementBase<State> element);
 
+  /// {@template notifier.listen}
   /// Listens to changes on the value exposed by this provider.
   ///
   /// The listener will be called immediately after the provider completes building.
   ///
   /// As opposed to [Ref.listen], the listener will be called even if
   /// [ProviderElementBase.updateShouldNotify] returns false, meaning that the previous
   /// and new value can potentially be identical.
+  /// {@endtemplate}
   void listenSelf(
     void Function(State? previous, State next) listener, {
     void Function(Object error, StackTrace stackTrace)? onError,