npmpackage.info

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

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

@octokit/types

13.6.2

Shared TypeScript definitions for Octokit projects

@octokit/plugin-enterprise-rest

6.0.1

Octokit plugin for GitHub Enterprise REST APIs

@octokit/plugin-paginate-rest

11.3.6

Octokit plugin to paginate REST API endpoint responses

@octokit/endpoint

10.1.1

Turns REST API endpoints into generic request options

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

@octokit/plugin-rest-endpoint-methods

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

13.2.6

116

MIT

TypeScript

1,206,998,614 7.4

Installations

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

Pull Requests

Open

3

Total

714

Closed

48

Merged

663

Issues

Open

6

Total

52

Closed

46

Releases

201

v13.2.6

Published on 03 Oct 2024

v13.2.5

Published on 27 Sept 2024

v13.2.4

Published on 02 Jul 2024

v13.2.2

Published on 02 May 2024

v13.2.1

Published on 30 Apr 2024

v13.2.0

Published on 29 Apr 2024

View all 201 releases

Developer

octokit

Developer Guide

BETA

Module System

ESM

Min. Node Version

>= 18

Typescript Support

Yes

Node Version

20.17.0

NPM Version

10.9.0 Statistics

116 Stars

911 Commits

57 Forks

13 Watching

16 Branches

26 Contributors

Updated on 27 Nov 2024

Languages

TypeScript (98.54%)

JavaScript (1.46%)

Total Downloads

Cumulative downloads

Total Downloads

1,206,998,614

Last day

-2.3%

1,714,758

Compared to previous day

Last week

6.6%

9,450,798

Compared to previous week

Last month

13%

37,901,751

Compared to previous month

Last year

14.3%

368,899,695

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

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

Dangerous-Workflow

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

10

Binary-Artifacts

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

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

Maintained

Determines if the project is "actively maintained".

9

Security-Policy

Determines if the project has published a security policy.

9

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

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/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:11: 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:17: 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:19: 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:54: 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:25
Info: 0 out of 15 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.4

/10

Last Scanned on 2024-11-18

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

Pull Requests

3

714

48

663

Issues

6

52

46

Releases

Developer

octokit

Developer Guide

ESM

>= 18

Yes

20.17.0

10.9.0

Statistics

Languages

Total Downloads

1,206,998,614

Daily Downloads

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

9

9

9

4

0

0

0

7.4

/10