v1.0.0

Signed-off-by: xsahil03x <xdsahil@gmail.com>

Author: xsahil03x

CHANGELOG.md

@@ -1,3 +1,8 @@
+## [1.0.0] - (14-12-2022)
+
+* Added BackOff.
+* Added support for passing nullable values in Debounce and Throttle function.
+
 ## [0.1.1] - (13-04-2021)
 
 * Add example.

README.md

@@ -17,6 +17,7 @@ _Rate limiting_ is a strategy for limiting an action. It puts a cap on how often
 - [Strategies](#strategies)
 	- [Debounce](#debounce)
 	- [Throttle](#throttle)
+    - [BackOff](#backoff)
 - [Pending](#pending)
 - [Flush](#flush)
 - [Cancellation](#cancellation)
@@ -74,8 +75,6 @@ TextField(
 );
 ```
 
-
-
 ### Throttle
 To _throttle_ a function means to ensure that the function is called at most once in a specified time period (for instance, once every 10 seconds). This means throttling will prevent a function from running if it has run “recently”. Throttling also ensures a function is run regularly at a fixed rate.
 
@@ -120,6 +119,53 @@ RaisedButton(
 );
 ```
 
+### BackOff
+BackOff is a strategy that allows you to retry a function call multiple times with a delay between each call. It is useful when you want to retry a function call multiple times in case of failure.
+
+#### Usage
+Creating backoff function is similar to debounce and throttle function.
+
+1. Creating from scratch
+```dart
+final response = backOff(
+  // Make a GET request
+  () => http.get('https://google.com').timeout(Duration(seconds: 5)),
+  maxAttempts: 5,
+  maxDelay: Duration(seconds: 5),
+  // Retry on SocketException or TimeoutException
+  retryIf: (e, _) => e is SocketException || e is TimeoutException,
+);
+```
+2. Converting an existing function into backoff function
+```dart
+Future<String> regularFunction() async {  
+  // Make a GET request
+  final response = await http.get('https://google.com').timeout(Duration(seconds: 5));
+  return response.body;
+}
+
+final response = regularFunction.backOff(
+  maxAttempts: 5,
+  maxDelay: Duration(seconds: 5),
+  // Retry on SocketException or TimeoutException
+  retryIf: (e, _) => e is SocketException || e is TimeoutException,
+);
+```
+
+#### Example
+While making a network request, it is possible that the request fails due to network issues. In such cases, it is useful to retry the request multiple times with a delay between each call. This is where backoff strategy comes in handy.
+
+```dart
+final response = backOff(
+  // Make a GET request
+  () => http.get('https://google.com').timeout(Duration(seconds: 5)),
+  maxAttempts: 5,
+  maxDelay: Duration(seconds: 5),
+  // Retry on SocketException or TimeoutException
+  retryIf: (e, _) => e is SocketException || e is TimeoutException,
+);
+```
+
 ### Pending
 Used to check if the there are functions still remaining to get invoked.
 ```dart

example/pubspec.yaml

@@ -8,7 +8,8 @@ environment:
   sdk: ">=2.12.0 <3.0.0"
 
 dependencies:
-  rate_limiter: ^0.1.1
+  rate_limiter:
+    path: ../
 
 dependency_overrides:
   rate_limiter:

pubspec.yaml

@@ -1,6 +1,6 @@
 name: rate_limiter
 description: A pure dart package to apply useful rate limiting strategies on regular functions.
-version: 0.1.1
+version: 1.0.0
 homepage: https://github.com/GetStream/rate_limiter
 repository: https://github.com/GetStream/rate_limiter
 issue_tracker: https://github.com/GetStream/rate_limiter/issues