Fixed the usage of asyncValue.guard in the doc

rrousselGit · Mar 20, 2024 · 0aea123 · 0aea123
1 parent 6557620
commit 0aea123
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/packages/flutter_riverpod/CHANGELOG.md b/packages/flutter_riverpod/CHANGELOG.md
@@ -1,7 +1,7 @@
 ## 2.5.2 - 2024-03-18
 
 - Fixed various typos in the documentation (thanks to @kevalvavaliya)
-
+- Fixed the usage of asyncValue.guard in the documentation (thanks to @drown0315) 
 ## 2.5.1 - 2024-03-10
 
 - Deprecate `ProviderScope.parent` due to fundamentally not working.

diff --git a/packages/riverpod/lib/src/common.dart b/packages/riverpod/lib/src/common.dart
@@ -133,9 +133,13 @@ abstract class AsyncValue<T> {
   ///     try {
   ///       final response = await dio.get('my_api/data');
   ///       final data = MyData.fromJson(response);
-  ///       state = AsyncValue.data(data);
+  ///       if(mounted){
+  ///          state = AsyncValue.data(data);
+  ///       }
   ///     } catch (err, stack) {
-  ///       state = AsyncValue.error(err, stack);
+  ///       if(mounted){
+  ///          state = AsyncValue.error(err, stack);
+  ///       }
   ///     }
   ///   }
   /// }
@@ -151,10 +155,13 @@ abstract class AsyncValue<T> {
   ///   Future<void> sideEffect() async {
   ///     state = const AsyncValue.loading();
   ///     // does the try/catch for us like previously
-  ///     state = await AsyncValue.guard(() async {
+  ///     final newState = await AsyncValue.guard(() async {
   ///       final response = await dio.get('my_api/data');
   ///       return Data.fromJson(response);
   ///     });
+  ///     if(mounted){
+  ///        state = newState;
+  ///     }
   ///   }
   /// }
   ///