From 40876aefd5197750fcacd5d20df2b49e3141cd8b Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Richardet Date: Mon, 22 Jul 2024 16:42:30 +0200 Subject: [PATCH] Fix signature of RetryHandler (#3416) (cherry picked from commit 53350135c8e786b04dce11e8bf5a9775d14d730b) --- docs/docs/api/RetryHandler.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/api/RetryHandler.md b/docs/docs/api/RetryHandler.md index 8988ee53010..0dd9f29533f 100644 --- a/docs/docs/api/RetryHandler.md +++ b/docs/docs/api/RetryHandler.md @@ -19,7 +19,7 @@ Extends: [`Dispatch.DispatchOptions`](Dispatcher.md#parameter-dispatchoptions). #### `RetryOptions` -- **retry** `(err: Error, context: RetryContext, callback: (err?: Error | null) => void) => void` (optional) - Function to be called after every retry. It should pass error if no more retries should be performed. +- **retry** `(err: Error, context: RetryContext, callback: (err?: Error | null) => void) => number | null` (optional) - Function to be called after every retry. It should pass error if no more retries should be performed. - **maxRetries** `number` (optional) - Maximum number of retries. Default: `5` - **maxTimeout** `number` (optional) - Maximum number of milliseconds to wait before retrying. Default: `30000` (30 seconds) - **minTimeout** `number` (optional) - Minimum number of milliseconds to wait before retrying. Default: `500` (half a second)