npmpackage.info

@octokit/types

Shared TypeScript definitions for Octokit projects

13.6.2

136

MIT

TypeScript

2,135,176,042 7.2

Installations

npm install @octokit/types

Pull Requests

Open

6

Total

561

Closed

23

Merged

532

Issues

Open

11

Total

95

Closed

84

Releases

212

v13.6.2

Published on 25 Nov 2024

v13.6.1

Published on 03 Oct 2024

v13.6.0

Published on 27 Sept 2024

v13.5.1

Published on 24 Sept 2024

v13.5.0

Published on 29 Apr 2024

v13.4.1

Published on 15 Apr 2024

View all 212 releases

Developer

octokit

Developer Guide

BETA

Module System

Unable to determine the module system for this package.

Min. Node Version

Typescript Support

Yes

Node Version

22.11.0

NPM Version

10.5.2 Statistics

136 Stars

640 Commits

32 Forks

6 Watching

9 Branches

25 Contributors

Updated on 28 Nov 2024

Languages

TypeScript (98.21%)

JavaScript (1.79%)

Total Downloads

Cumulative downloads

Total Downloads

2,135,176,042

Last day

-10.9%

3,207,043

Compared to previous day

Last week

3.8%

19,797,960

Compared to previous week

Last month

7.5%

80,528,495

Compared to previous month

Last year

33.1%

751,902,918

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@octokit/openapi-types

Dev Dependencies

@octokit/tsconfig github-openapi-graphql-query handlebars npm-run-all2 prettier semantic-release semantic-release-plugin-update-version-in-files sort-keys typedoc typescript

Versions

types.ts

Shared TypeScript definitions for Octokit projects

Usage
Examples
- Get parameter and response data types for a REST API endpoint
- Get response types from endpoint methods
Contributing
License

Usage

See all exported types at https://octokit.github.io/types.ts

Examples

Get parameter and response data types for a REST API endpoint

1import { Endpoints } from "@octokit/types";
2
3type listUserReposParameters =
4  Endpoints["GET /repos/{owner}/{repo}"]["parameters"];
5type listUserReposResponse = Endpoints["GET /repos/{owner}/{repo}"]["response"];
6
7async function listRepos(
8  options: listUserReposParameters,
9): listUserReposResponse["data"] {
10  // ...
11}

Get response types from endpoint methods

1import {
2  GetResponseTypeFromEndpointMethod,
3  GetResponseDataTypeFromEndpointMethod,
4} from "@octokit/types";
5import { Octokit } from "@octokit/rest";
6
7const octokit = new Octokit();
8type CreateLabelResponseType = GetResponseTypeFromEndpointMethod<
9  typeof octokit.issues.createLabel
10>;
11type CreateLabelResponseDataType = GetResponseDataTypeFromEndpointMethod<
12  typeof octokit.issues.createLabel
13>;

Contributing

See CONTRIBUTING.md

License

MIT

No vulnerabilities found.

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

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

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

Security-Policy

Determines if the project has published a security policy.

8

Maintained

Determines if the project is "actively maintained".

8

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

3

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 3

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/types.ts/add_to_octokit_project.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/types.ts/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/types.ts/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/types.ts/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/types.ts/immediate-response.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-notification.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/types.ts/release-notification.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-notification.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/types.ts/release-notification.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/types.ts/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/types.ts/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/types.ts/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/types.ts/update.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/types.ts/update.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/update.yml:18
Info: 4 out of 11 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 5 third-party GitHubAction dependencies pinned
Info: 3 out of 4 npmCommand dependencies pinned

0

Token-Permissions

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

0

CII-Best-Practices

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

0

Fuzzing

Determines if the project uses fuzzing.

Score

7.2

/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