Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 3,096 Commits
.github		.github
assets		assets
docs		docs
scripts		scripts
src		src
test		test
.gitignore		.gitignore
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
HOW_IT_WORKS.md		HOW_IT_WORKS.md
LICENSE		LICENSE
README.md		README.md
SECURITY.md		SECURITY.md
cypress.json		cypress.json
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json
vite.config.js		vite.config.js

Repository files navigation

rest.js

GitHub REST API client for JavaScript

Usage

Browsers	Load`@octokit/rest` directly fromesm.sh <scripttype="module">import{Octokit}from"https://esm.sh/@octokit/rest";</script>
Node	Install with`npm install @octokit/rest` import{Octokit}from"@octokit/rest";

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

constoctokit=newOctokit();// Compare: https://docs.github.com/en/rest/reference/repos/#list-organization-repositoriesoctokit.rest.repos.listForOrg({org:"octokit",type:"public",}).then(({ data})=>{// handle data});

Seehttps://octokit.github.io/rest.js for full documentation.

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

Contributing

We would love you to contribute to@octokit/rest, pull requests are very welcome! Please seeCONTRIBUTING.md for more information.

Credits

@octokit/rest was originally created asnode-github in 2012 by Mike de Boer from Cloud9 IDE, Inc.The original commit is from 2010 which predates the npm registry.

It was adopted and renamed by GitHub in 2017. Learn more about its origin on GitHub's blog:From 48k lines of code to 10—the story of GitHub’s JavaScript SDK