diff options
| author | pack <pack@packgekko.xyz> | 2026-08-09 10:54:08 +0000 |
|---|---|---|
| committer | pack <pack@packgekko.xyz> | 2026-08-09 10:54:08 +0000 |
| commit | d3adc16a08d95d6e331de55d7d3bf05a66a874a8 (patch) | |
| tree | a2dabd199501e67c547c2ce79e1374ca3aa55443 /node_modules/exponential-backoff/README.md | |
| parent | 55a4f1fc869e41aca748c63d3018f0448b1606e0 (diff) | |
| download | crud-d3adc16a08d95d6e331de55d7d3bf05a66a874a8.tar.gz | |
stop tracking node_modules/
Diffstat (limited to 'node_modules/exponential-backoff/README.md')
| -rw-r--r-- | node_modules/exponential-backoff/README.md | 89 |
1 files changed, 0 insertions, 89 deletions
diff --git a/node_modules/exponential-backoff/README.md b/node_modules/exponential-backoff/README.md deleted file mode 100644 index 10c7568..0000000 --- a/node_modules/exponential-backoff/README.md +++ /dev/null @@ -1,89 +0,0 @@ -# exponential-backoff - -A utility that allows retrying a function with an exponential delay between attempts. - -## Installation - -``` -npm i exponential-backoff -``` - -## Usage - -The `backOff<T>` function takes a promise-returning function to retry, and an optional `BackOffOptions` object. It returns a `Promise<T>`. - -```ts -function backOff<T>( - request: () => Promise<T>, - options?: BackOffOptions -): Promise<T>; -``` - -Here is an example retrying a function that calls a hypothetical weather endpoint: - -```js -import { backOff } from "exponential-backoff"; - -function getWeather() { - return fetch("weather-endpoint"); -} - -async function main() { - try { - const response = await backOff(() => getWeather()); - // process response - } catch (e) { - // handle error - } -} - -main(); -``` - -Migrating across major versions? Here are our [breaking changes](https://github.com/coveo/exponential-backoff/tree/master/doc/migration-guide.md). - -### `BackOffOptions` - -- `delayFirstAttempt?: boolean` - - Decides whether the `startingDelay` should be applied before the first call. If `false`, the first call will occur without a delay. - - Default value is `false`. - -- `jitter?: JitterType | string` - - Decides whether a [jitter](https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/) should be applied to the delay. Possible values are `full` and `none`. - - Default value is `none`. - -- `maxDelay?: number` - - The maximum delay, in milliseconds, between two consecutive attempts. - - Default value is `Infinity`. - -- `numOfAttempts?: number` - - The maximum number of times to attempt the function. - - Default value is `10`. - - Minimum value is `1`. - -- `retry?: (e: any, attemptNumber: number) => boolean | Promise<boolean>` - - The `retry` function can be used to run logic after every failed attempt (e.g. logging a message, assessing the last error, etc.). It is called with the last error and the upcoming attempt number. Returning `true` will retry the function as long as the `numOfAttempts` has not been exceeded. Returning `false` will end the execution. - - Default value is a function that always returns `true`. - -- `startingDelay?: number` - - The delay, in milliseconds, before executing the function for the first time. - - Default value is `100` ms. - -- `timeMultiple?: number` - - The `startingDelay` is multiplied by the `timeMultiple` to increase the delay between reattempts. - - Default value is `2`. |