npmpackage.info

@octokit/plugin-retry

Octokit plugin for GitHub’s recommended request retries

7.1.2

MIT

TypeScript

Installations

npm install @octokit/plugin-retry

Pull Requests

Open

4

Total

551

Closed

26

Merged

521

Issues

Open

6

Total

44

Closed

38

Releases

v7.1.2

Published on 18 Sept 2024

v7.1.1

Published on 23 Apr 2024

v7.1.0

Published on 03 Apr 2024

v7.0.4

Published on 03 Apr 2024

v7.0.3

Published on 01 Mar 2024

v7.0.2

Published on 27 Feb 2024

View all 44 releases

Developer

octokit

Developer Guide

BETA

Module System

ESM

Min. Node Version

>= 18

Typescript Support

Yes

Node Version

20.17.0

NPM Version

10.8.3 Statistics

38 Stars

604 Commits

18 Forks

12 Watching

8 Branches

24 Contributors

Updated on 26 Nov 2024

Languages

TypeScript (88.17%)

JavaScript (11.83%)

Total Downloads

Cumulative downloads

Total Downloads

153,188,712

Last day

-4.5%

392,707

Compared to previous day

Last week

4.3%

2,322,796

Compared to previous week

Last month

9.2%

9,756,869

Compared to previous month

Last year

118.1%

91,035,336

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

plugin-retry.js

Retries requests for server 4xx/5xx responses except 400, 401, 403, 404, 422, and 451.

Usage

Browsers

Browsers	Load `@octokit/plugin-retry` and `@octokit/core` (or core-compatible module) directly from esm.sh `1<script type="module"> 2 import { Octokit } from "https://esm.sh/@octokit/core"; 3 import { retry } from "https://esm.sh/@octokit/plugin-retry"; 4</script>`
Node	Install with `npm install @octokit/core @octokit/plugin-retry`. Optionally replace `@octokit/core` with a core-compatible module `1import { Octokit } from "@octokit/core"; 2import { retry } from "@octokit/plugin-retry";`

Load @octokit/plugin-retry and @octokit/core (or core-compatible module) directly from esm.sh

1<script type="module">
2  import { Octokit } from "https://esm.sh/@octokit/core";
3  import { retry } from "https://esm.sh/@octokit/plugin-retry";
4</script>

Node

Install with npm install @octokit/core @octokit/plugin-retry. Optionally replace @octokit/core with a core-compatible module

1import { Octokit } from "@octokit/core";
2import { retry } from "@octokit/plugin-retry";

[!IMPORTANT] As we use conditional exports, you will need to adapt your tsconfig.json by setting "moduleResolution": "node16", "module": "node16".

See the TypeScript docs on package.json "exports".
See this helpful guide on transitioning to ESM from @sindresorhus

1const MyOctokit = Octokit.plugin(retry);
2const octokit = new MyOctokit({ auth: "secret123" });
3
4// retries request up to 3 times in case of a 500 response
5octokit.request("/").catch((error) => {
6  if (error.request.request.retryCount) {
7    console.log(
8      `request failed after ${error.request.request.retryCount} retries`,
9    );
10  }
11
12  console.error(error);
13});

To override the default doNotRetry list:

1const octokit = new MyOctokit({
2  auth: "secret123",
3  retry: {
4    doNotRetry: [
5      /* List of HTTP 4xx/5xx status codes */
6    ],
7  },
8});

To override the number of retries:

1const octokit = new MyOctokit({
2  auth: "secret123",
3  request: { retries: 1 },
4});

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.

1octokit
2  .request("/", { request: { retries: 1, retryAfter: 1 } })
3  .catch((error) => {
4    if (error.request.request.retryCount) {
5      console.log(
6        `request failed after ${error.request.request.retryCount} retries`,
7      );
8    }
9
10    console.error(error);
11  });

Pass { retry: { enabled: false } } to disable this plugin.

Contributing

See CONTRIBUTING.md

License

MIT

No vulnerabilities found.

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Maintained

Determines if the project is "actively maintained".

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

10

SAST

Determines if the project uses static code analysis.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

9

Security-Policy

Determines if the project has published a security policy.

5

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 5

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/add_to_octokit_project.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-retry.js/add_to_octokit_project.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-retry.js/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-retry.js/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-retry.js/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:72: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-retry.js/codeql-analysis.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/immediate-response.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-retry.js/immediate-response.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-retry.js/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-retry.js/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-retry.js/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-retry.js/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-retry.js/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-prettier.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-retry.js/update-prettier.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-prettier.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-retry.js/update-prettier.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-prettier.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-retry.js/update-prettier.yml/main?enable=pin
Info: 0 out of 12 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 2 third-party GitHubAction dependencies pinned
Info: 4 out of 4 npmCommand dependencies pinned

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

Score

7.7

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@octokit/plugin-retry

Installations

Pull Requests

4

551

26

521

Issues

6

44

38

Releases

Developer

octokit

Developer Guide

ESM

>= 18

Yes

20.17.0

10.8.3

Statistics

Languages

Total Downloads

153,188,712

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

plugin-retry.js

Usage

Contributing

License

10

10

10

10

10

10

10

10

9

5

0

0

0

7.7

/10