docs: document cause argument to onRetry (#173)

npm · Oct 4, 2022 · d63de44 · d63de44
1 parent 2aeaae5
commit d63de44
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -321,14 +321,14 @@ fetch('http://one-more.site.com', {
 
 #### <a name="opts-onretry"></a> `> opts.onRetry`
 
-A function called whenever a retry is attempted.
+A function called with the response or error which caused the retry whenever one is attempted.
 
 ##### Example
 
 ```javascript
 fetch('https://flaky.site.com', {
-  onRetry() {
-    console.log('we will retry!')
+  onRetry(cause) {
+    console.log('we will retry because of', cause)
   }
 })
 ```