npmpackage.info

Gathering detailed insights and metrics for @octokit/plugin-retry

@octokit/plugin-retry - 8.0.1 | npmpackage.info

@octokit/plugin-retry

Octokit plugin for GitHub’s recommended request retries

8.0.1

MIT

TypeScript

15.51 kB

7.4

Installations

npm install @octokit/plugin-retry

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Min. Node Version

>= 20

Node Version

22.15.0

NPM Version

10.9.2 Pull Requests

Open

5

Total

589

Closed

30

Merged

554

Issues

Open

6

Total

45

Closed

39

Releases

v8.0.1

Updated on May 20, 2025

v8.0.0

Updated on May 20, 2025

v7.2.1

Updated on Apr 10, 2025

v7.2.0

Updated on Mar 18, 2025

v7.1.4

Updated on Feb 14, 2025

v7.1.3

Updated on Jan 07, 2025

View All 51 releases

Languages

TypeScript

JavaScript

TypeScript (88.17%)

JavaScript (11.83%)

Developer

octokit

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

48 Stars

637 Commits

23 Forks

11 Watchers

9 Branches

26 Contributors

Updated on Jun 30, 2025

Maintainers

View All 26 Contributors

Package Meta Information

Latest Version

8.0.1

Package Id

@octokit/plugin-retry@8.0.1

Unpacked Size

15.51 kB

Size

4.76 kB

File Count

NPM Version

10.9.2

Node Version

22.15.0

Published on

May 20, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

plugin-retry.js

Retries requests for server 4xx/5xx responses except 400, 401, 403, 404, 410, 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

Binary-Artifacts

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

10

Dangerous-Workflow

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

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.

9

Security-Policy

Determines if the project has published a security policy.

9

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

8

Maintained

Determines if the project is "actively maintained".

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.4

/10

Last Scanned on 2025-06-30

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

Developer Guide

Yes

ESM

>= 20

22.15.0

10.9.2

Pull Requests

5

589

30

554

Issues

6

45

39

Releases

Languages

Developer

octokit

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

plugin-retry.js

Usage

Contributing

License

10

10

10

10

10

10

9

9

8

5

0

0

0

7.4

/10