Feat/add refresh when returning to foreground extension

README.md

@@ -1,4 +1,4 @@
-# Riverpods Community Extensions
+# Riverpod Community Extensions
 
 [![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
 [![Powered by Mason](https://img.shields.io/endpoint?url=https%3A%2F%2Ftinyurl.com%2Fmason-badge)](https://github.com/felangel/mason)
@@ -22,12 +22,12 @@ This package adds the following methods to ref types:
 
 ## Installation 💻
 
-**❗ In order to start using Riverpods Community Extensions you must have the [Dart SDK][dart_install_link] installed on your machine.**
+**❗ In order to start using Riverpod Community Extensions you must have the [Dart SDK][dart_install_link] installed on your machine.**
 
 Install via `dart pub add`:
 
 ```sh
-dart pub add riverpods_community_extensions
+dart pub add riverpod_community_extensions
 ```
 
 ## Usage 🎨
@@ -37,7 +37,7 @@ Simply import the package and use the provided extensions on your ref types.
 Example without codegen:
 
 ```dart
-import 'package:riverpods_community_extensions/riverpods_community_extensions.dart';
+import 'package:riverpod_community_extensions/riverpod_community_extensions.dart';
 import 'package:riverpod/riverpod.dart';
 
 final dataProvider = FutureProvider.autoDispose((ref) async {
@@ -50,7 +50,7 @@ final dataProvider = FutureProvider.autoDispose((ref) async {
 Example with codegen:
 
 ```dart
-import 'package:riverpods_community_extensions/riverpods_community_extensions.dart';
+import 'package:riverpod_community_extensions/riverpod_community_extensions.dart';
 import 'package:riverpod/riverpod.dart';
 
 part 'data_provider.g.dart';

lib/riverpods_community_extensions.dart → lib/riverpod_community_extensions.dart

@@ -1,7 +1,7 @@
-/// Community extensions for Riverpods
-library riverpods_community_extensions;
+/// Community extensions for riverpod
+library riverpod_community_extensions;
 
-export 'src/auto_refresh_extension.dart';
 export 'src/cache_data_for_extension.dart';
 export 'src/cache_for_extension.dart';
 export 'src/debounce_extension.dart';
+export 'src/refresh_extension.dart';

lib/src/refresh_extension.dart

@@ -0,0 +1,61 @@
+import 'dart:async';
+import 'package:flutter/widgets.dart';
+import 'package:riverpod/riverpod.dart';
+
+/// Adds auto-refresh functionalities to AutoDisposeRef<T> objects.
+///
+/// See [autoRefresh] and [refreshWhenReturningToForeground] for more details.
+extension RefreshExtension<T> on AutoDisposeRef<T> {
+  /// Refreshes the value at the specified interval.
+  ///
+  /// This can be useful for scenarios where you want to refresh a value at a
+  /// specified interval.
+  ///
+  /// Example usages:
+  ///
+  /// without codegen:
+  /// ```dart
+  /// final dataProvider = Provider<int>((ref) {
+  ///   ref.autoRefresh(const Duration(seconds: 1));
+  ///   return fetchData();
+  /// });
+  /// ```
+  ///
+  /// with codegen:
+  /// ```dart
+  /// @riverpod
+  /// int data(DataRef ref) {
+  ///   ref.autoRefresh(const Duration(seconds: 1));
+  ///   return fetchData();
+  /// }
+  /// ```
+  void autoRefresh(Duration duration) {
+    final timer = Timer(duration, invalidateSelf);
+    onDispose(timer.cancel);
+  }
+
+  /// Refreshes the value each time the app returns to foreground.
+  ///
+  /// Example usages:
+  /// without codegen:
+  /// ```dart
+  /// final dataProvider = Provider<int>((ref) {
+  ///   ref.refreshWhenReturningToForeground();
+  ///   return fetchData();
+  /// });
+  /// ```
+  ///
+  /// with codegen:
+  /// ```dart
+  /// @riverpod
+  /// int data(DataRef ref) {
+  ///   ref.refreshWhenReturningToForeground();
+  ///   return fetchData();
+  /// }
+  /// ```
+  ///
+  void refreshWhenReturningToForeground() {
+    final listener = AppLifecycleListener(onResume: invalidateSelf);
+    onDispose(listener.dispose);
+  }
+}