From 497ab8e9ca0aead403a47bc280294831325af9ff Mon Sep 17 00:00:00 2001 From: Tanguy Mossion Date: Tue, 27 Aug 2024 09:02:44 +0200 Subject: [PATCH] chores(readme): add autoRefresh and refreshWhenReturningToForeground feature descriptions --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3ffd18e..d4a34f7 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,11 @@ This package adds the following methods to ref types: - `debounce` on `AutoDisposeFutureProviderRef` - Wait for a specified duration before calling the provider's computation, and cancel the previous call if a new one is made. -- `refreshWhenNetworkAvailable` on `AutoDisposeFutureProviderRef` - Automatically refresh the provider when the network is available. Uses the package [connectivity_plus](https://pub.dev/packages/connectivity_plus). +- `autoRefresh` on `AutoDisposeRef` - Refreshes the value at a specified interval. Useful for scenarios where periodic updates of a provider's value are required. + +- `refreshWhenReturningToForeground` on `AutoDisposeRef` - Refreshes the provider's value each time the app returns to the foreground, ensuring the data is always up to date after returning to the app. + +- `refreshWhenNetworkAvailable` on `AutoDisposeRef` - Automatically refresh the provider when the network is available. Uses the package [connectivity_plus](https://pub.dev/packages/connectivity_plus). ## Installation 💻