From 0a5d4cb5ea0b206ac6cb15739384f31fd86e34a2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pablo=20Rodr=C3=ADguez?= Date: Mon, 25 Mar 2019 16:28:04 +0100 Subject: [PATCH] Document onRetry's second parameter --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 65eeea8..697204c 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ retry(retrier : Function, opts : Object) => Promise * `minTimeout`: The number of milliseconds before starting the first retry. Default is `1000`. * `maxTimeout`: The maximum number of milliseconds between two retries. Default is `Infinity`. * `randomize`: Randomizes the timeouts by multiplying with a factor between `1` to `2`. Default is `true`. - * `onRetry`: an optional `Function` that is invoked after a new retry is performed. It's passed the `Error` that triggered it as a parameter. + * `onRetry`: an optional `Function` that is invoked after a new retry is performed. It's passed the `Error` that triggered it as the first parameter, and the attempt number as the second parameter. ## Authors