Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 935 Commits
.github		.github
docs		docs
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-rest-endpoint-methods.js

Octokit plugin adding one method for all of api.github.com REST API endpoints

Usage

Browsers

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

Load@octokit/plugin-rest-endpoint-methods and@octokit/core (or core-compatible module) directly fromesm.sh

<scripttype="module">import{Octokit}from"https://esm.sh/@octokit/core";import{restEndpointMethods}from"https://esm.sh/@octokit/plugin-rest-endpoint-methods";</script>

Node

Install withnpm install @octokit/core @octokit/plugin-rest-endpoint-methods. Optionally replace@octokit/core with a compatible module

import{Octokit}from"@octokit/core";import{restEndpointMethods}from"@octokit/plugin-rest-endpoint-methods";

constMyOctokit=Octokit.plugin(restEndpointMethods);constoctokit=newMyOctokit({auth:"secret123"});// https://developer.github.com/v3/users/#get-the-authenticated-useroctokit.rest.users.getAuthenticated();

There is one method for each REST API endpoint documented athttps://developer.github.com/v3. All endpoint methods are documented in thedocs/ folder, e.g.docs/users/getAuthenticated.md

TypeScript

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

Parameter and response types for all endpoint methods exported as{ RestEndpointMethodTypes }.

Example

import{RestEndpointMethodTypes}from"@octokit/plugin-rest-endpoint-methods";typeUpdateLabelParameters=RestEndpointMethodTypes["issues"]["updateLabel"]["parameters"];typeUpdateLabelResponse=RestEndpointMethodTypes["issues"]["updateLabel"]["response"];

In order to get types beyond parameters and responses, check out@octokit/openapi-types, which is a direct transpilation from GitHub's official OpenAPI specification.