Skip to content

Commit 96cd2bb

Browse files
committed
chore: reduce maxRetryAfterTime 10 by default
1 parent c4a4c37 commit 96cd2bb

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -154,15 +154,18 @@ Customize `User-Agent` http header.
154154

155155
The max of waiting seconds for retry. It is related to `retry` option.
156156

157-
:memo: It does affect to `Retry-After` header. If you want to max waiting seconds for `Retry-After` header, please use `maxRetryAfterTime` option.
157+
:memo: It does affect to [`Retry-After`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After) header. If you want to max waiting seconds for `Retry-After` header, please use `maxRetryAfterTime` option.
158158

159159
Default: `10`
160160

161161
### maxRetryAfterTime
162162

163-
The max of allow waiting time second for `maxRetryAfterTime` header value.
163+
The max of allow waiting time second for [`Retry-After`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After) header value.
164164

165-
Default: `90`
165+
Some website like GitHub returns `Retry-After` header value with `429 too many requests`.
166+
This `maxRetryAfterTime` option is for that `Retry-After`.
167+
168+
Default: `10`
166169

167170
## Tests
168171

src/no-dead-link.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ const DEFAULT_OPTIONS: Options = {
4040
keepAlive: false, // {boolean} if it is true, use keepAlive for checking request [Experimental]
4141
userAgent: "textlint-rule-no-dead-link/1.0", // {String} a UserAgent,
4242
maxRetryTime: 10, // (number) The max of waiting seconds for retry. It is related to `retry` option. It does affect to `Retry-After` header.
43-
maxRetryAfterTime: 90 // (number) The max of waiting seconds for `Retry-After` header.
43+
maxRetryAfterTime: 10 // (number) The max of waiting seconds for `Retry-After` header.
4444
};
4545

4646
// Adopted from http://stackoverflow.com/a/3809435/951517
@@ -231,7 +231,7 @@ const createCheckAliveURL = (ruleOptions: Options) => {
231231
if (currentRetryCount < maxRetryCount) {
232232
const retryAfter = res.headers.get("Retry-After");
233233
// If the response has `Retry-After` header, prefer it
234-
// e.g. Retry-After: 60 and `maxRetryAfterTime: 90`, wait 60 seconds
234+
// e.g. `Retry-After: 60` and `maxRetryAfterTime: 90`, wait 60 seconds
235235
if (retryAfter) {
236236
const retryAfterMs = Number(retryAfter) * 1000;
237237
const maxRetryAfterTimeMs = ruleOptions.maxRetryAfterTime * 1000;

0 commit comments

Comments
 (0)