Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 648 Commits
.github		.github
scripts		scripts
src		src
test		test
.gitignore		.gitignore
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
SECURITY.md		SECURITY.md
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json
vite.config.js		vite.config.js

Repository files navigation

plugin-retry.js

Retries requests for server 4xx/5xx responses except400,401,403,404,410,422, and451.

Usage

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

Important

As we useconditional exports, you will need to adapt yourtsconfig.json by setting"moduleResolution": "node16", "module": "node16".

See the TypeScript docs onpackage.json "exports".
See thishelpful guide on transitioning to ESM from@sindresorhus

constMyOctokit=Octokit.plugin(retry);constoctokit=newMyOctokit({auth:"secret123"});// retries request up to 3 times in case of a 500 responseoctokit.request("/").catch((error)=>{if(error.request.request.retryCount){console.log(`request failed after${error.request.request.retryCount} retries`,);}console.error(error);});

To override the defaultdoNotRetry list:

constoctokit=newMyOctokit({auth:"secret123",retry:{doNotRetry:[/* List of HTTP 4xx/5xx status codes */],},});

To override the number of retries:

constoctokit=newMyOctokit({auth:"secret123",request:{retries:1},});

You can manually ask for retries for any request by passing{ request: { retries: numRetries, retryAfter: delayInSeconds }}. Note that thedoNotRetry option from the constructor is ignored in this case, requests will be retried no matter their response code.

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);});