Tweak docs wording a bit more

sindresorhus · Oct 31, 2022 · c90d1d7 · c90d1d7
1 parent 945a07f
commit c90d1d7
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 5 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
diff --git a/readme.md b/readme.md
@@ -177,8 +177,9 @@ If `retry` is a number, it will be used as `limit` and other defaults will remai
 
 If `maxRetryAfter` is set to `undefined`, it will use `options.timeout`. If [`Retry-After`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After) header is greater than `maxRetryAfter`, it will cancel the request.
 
-By default, the delay is calculated with `0.3 * (2 ** (attemptCount - 1)) * 1000`. The delay increases exponentially.
+The `backoffLimit` option is the upper limit of the delay per retry in milliseconds.
 To clamp the delay, set `backoffLimit` to 1000, for example.
+By default, the delay is calculated with `0.3 * (2 ** (attemptCount - 1)) * 1000`. The delay increases exponentially.
 
 Retries are not triggered following a [timeout](#timeout).
 

diff --git a/source/types/retry.ts b/source/types/retry.ts
@@ -36,6 +36,7 @@ export interface RetryOptions {
 
 	/**
 	The upper limit of the delay per retry in milliseconds.
+	To clamp the delay, set `backoffLimit` to 1000, for example.
 
 	By default, the delay is calculated in the following way:
 
@@ -45,7 +46,7 @@ export interface RetryOptions {
 
 	The delay increases exponentially.
 
-  To clamp the delay, set `backoffLimit` to 1000, for example.
+	@default Infinity
 	*/
 	backoffLimit?: number;
 }