npmpackage.info

Gathering detailed insights and metrics for @octokit/plugin-rest-endpoint-methods

Other packages similar to @octokit/plugin-rest-endpoint-methods

octokit-rest-plugin-add-endpoints

1.0.0

@octokit/rest plugin to add endpoint methods based on a routes.json file

Gathering detailed insights and metrics for @octokit/plugin-rest-endpoint-methods

@octokit/plugin-rest-endpoint-methods - 15.0.0 | npmpackage.info

@octokit/plugin-rest-endpoint-methods

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

15.0.0

119

MIT

TypeScript

1.25 MB

1,430,651,999 7.6

Installations

npm install @octokit/plugin-rest-endpoint-methods

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Min. Node Version

>= 20

Node Version

22.15.0

NPM Version

10.9.2 Score

99.1

Supply Chain

94.8

Quality

89.3

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

1

Total

737

Closed

50

Merged

686

Issues

Open

7

Total

54

Closed

47

Releases

208

v15.0.0

Updated on May 20, 2025

v14.0.0

Updated on Apr 10, 2025

v13.5.0

Updated on Mar 18, 2025

v13.4.0

Updated on Mar 18, 2025

v13.3.2-cjs.1

Updated on Feb 26, 2025

v13.3.1

Updated on Feb 07, 2025

View All 208 releases

Languages

TypeScript

JavaScript

TypeScript (98.62%)

JavaScript (1.38%)

Developer

octokit

Download Statistics

Total Downloads

1,430,651,999

Last Day

1,934,928

Last Week

10,863,148

Last Month

43,956,090

Last Year

429,591,207

GitHub Statistics

MIT License

119 Stars

934 Commits

59 Forks

12 Watchers

15 Branches

29 Contributors

Updated on May 21, 2025

Maintainers

View All 29 Contributors

Package Meta Information

Latest Version

15.0.0

Package Id

@octokit/plugin-rest-endpoint-methods@15.0.0

Unpacked Size

1.25 MB

Size

132.62 kB

File Count

NPM Version

10.9.2

Node Version

22.15.0

Published on

May 20, 2025

Total Downloads

Cumulative downloads

Total Downloads

1,430,651,999

Last Day

7.1%

1,934,928

Compared to previous day

Last Week

6.3%

10,863,148

Compared to previous week

Last Month

3.6%

43,956,090

Compared to previous month

Last Year

29.4%

429,591,207

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

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 from esm.sh `1<script type="module"> 2 import { Octokit } from "https://esm.sh/@octokit/core"; 3 import { restEndpointMethods } from "https://esm.sh/@octokit/plugin-rest-endpoint-methods"; 4</script>`
Node	Install with `npm install @octokit/core @octokit/plugin-rest-endpoint-methods`. Optionally replace `@octokit/core` with a compatible module `1import { Octokit } from "@octokit/core"; 2import { restEndpointMethods } from "@octokit/plugin-rest-endpoint-methods";`

Load @octokit/plugin-rest-endpoint-methods 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 { restEndpointMethods } from "https://esm.sh/@octokit/plugin-rest-endpoint-methods";
4</script>

Node

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

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

1const MyOctokit = Octokit.plugin(restEndpointMethods);
2const octokit = new MyOctokit({ auth: "secret123" });
3
4// https://developer.github.com/v3/users/#get-the-authenticated-user
5octokit.rest.users.getAuthenticated();

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

TypeScript

[!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

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

Example

1import { RestEndpointMethodTypes } from "@octokit/plugin-rest-endpoint-methods";
2
3type UpdateLabelParameters =
4  RestEndpointMethodTypes["issues"]["updateLabel"]["parameters"];
5type UpdateLabelResponse =
6  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.

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

Maintained

Determines if the project is "actively maintained".

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

Binary-Artifacts

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

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.

4

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 4

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-rest-endpoint-methods.js/add_to_octokit_project.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/add_to_octokit_project.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-rest-endpoint-methods.js/add_to_octokit_project.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-rest-endpoint-methods.js/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-rest-endpoint-methods.js/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-rest-endpoint-methods.js/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-rest-endpoint-methods.js/codeql.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-rest-endpoint-methods.js/immediate-response.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-rest-endpoint-methods.js/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-rest-endpoint-methods.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-rest-endpoint-methods.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-rest-endpoint-methods.js/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-rest-endpoint-methods.js/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-rest-endpoint-methods.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-rest-endpoint-methods.js/update-prettier.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-prettier.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-rest-endpoint-methods.js/update-prettier.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-prettier.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-rest-endpoint-methods.js/update-prettier.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-prettier.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-rest-endpoint-methods.js/update-prettier.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-rest-endpoint-methods.js/update.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-rest-endpoint-methods.js/update.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-rest-endpoint-methods.js/update.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-rest-endpoint-methods.js/update.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/update.yml:30
Info: 0 out of 18 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 3 third-party GitHubAction dependencies pinned
Info: 5 out of 6 npmCommand dependencies pinned

0

CII-Best-Practices

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

0

Token-Permissions

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

0

Fuzzing

Determines if the project uses fuzzing.

Score

7.6

/10

Last Scanned on 2025-05-12

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

Other packages similar to @octokit/plugin-rest-endpoint-methods

Other packages similar to @octokit/plugin-rest-endpoint-methods

@octokit/plugin-rest-endpoint-methods

Installations

Developer Guide

Yes

ESM

>= 20

22.15.0

10.9.2

Score

Pull Requests

1

737

50

686

Issues

7

54

47

Releases

Languages

Developer

octokit

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

1,430,651,999

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

plugin-rest-endpoint-methods.js

Usage

TypeScript

Contributing

License

10

10

10

10

10

10

10

10

9

4

0

0

0

7.6

/10