Permalink
Cannot retrieve contributors at this time
103 lines (78 sloc)
2.46 KB
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
codeql-action/node_modules/@octokit/plugin-retry/README.md
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# plugin-retry.js | |
> Retries requests for server 4xx/5xx responses except `400`, `401`, `403`, `404`, `422`, and `451`. | |
[](https://www.npmjs.com/package/@octokit/plugin-retry) | |
[](https://github.com/octokit/plugin-retry.js/actions?workflow=Test) | |
## Usage | |
<table> | |
<tbody valign=top align=left> | |
<tr><th> | |
Browsers | |
</th><td width=100%> | |
Load `@octokit/plugin-retry` and [`@octokit/core`](https://github.com/octokit/core.js) (or core-compatible module) directly from [esm.sh](https://esm.sh) | |
```html | |
<script type="module"> | |
import { Octokit } from "https://esm.sh/@octokit/core"; | |
import { retry } from "https://esm.sh/@octokit/plugin-retry"; | |
</script> | |
``` | |
</td></tr> | |
<tr><th> | |
Node | |
</th><td> | |
Install with `npm install @octokit/core @octokit/plugin-retry`. Optionally replace `@octokit/core` with a core-compatible module | |
```js | |
const { Octokit } = require("@octokit/core"); | |
const { retry } = require("@octokit/plugin-retry"); | |
``` | |
</td></tr> | |
</tbody> | |
</table> | |
```js | |
const MyOctokit = Octokit.plugin(retry); | |
const octokit = new MyOctokit({ auth: "secret123" }); | |
// retries request up to 3 times in case of a 500 response | |
octokit.request("/").catch((error) => { | |
if (error.request.request.retryCount) { | |
console.log( | |
`request failed after ${error.request.request.retryCount} retries` | |
); | |
} | |
console.error(error); | |
}); | |
``` | |
To override the default `doNotRetry` list: | |
```js | |
const octokit = new MyOctokit({ | |
auth: "secret123", | |
retry: { | |
doNotRetry: [ | |
/* List of HTTP 4xx/5xx status codes */ | |
], | |
}, | |
}); | |
``` | |
To override the number of retries: | |
```js | |
const octokit = new MyOctokit({ | |
auth: "secret123", | |
request: { retries: 1 }, | |
}); | |
``` | |
You can manually ask for retries for any request by passing `{ request: { retries: numRetries, retryAfter: delayInSeconds }}`. Note that the `doNotRetry` option from the constructor is ignored in this case, requests will be retried no matter their response code. | |
```js | |
octokit | |
.request("/", { request: { retries: 1, retryAfter: 1 } }) | |
.catch((error) => { | |
if (error.request.request.retryCount) { | |
console.log( | |
`request failed after ${error.request.request.retryCount} retries` | |
); | |
} | |
console.error(error); | |
}); | |
``` | |
Pass `{ retry: { enabled: false } }` to disable this plugin. | |
## Contributing | |
See [CONTRIBUTING.md](CONTRIBUTING.md) | |
## License | |
[MIT](LICENSE) |