npmpackage.info

Gathering detailed insights and metrics for @octokit/types

Other packages similar to @octokit/types

@octokit/openapi-types

25.1.0

Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

@octokit/webhooks-types

7.6.1

Generated TypeScript definitions based on community contributed JSON Schemas

@octokit/openapi-webhooks-types

12.0.3

Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

@octokit-next/types

3.0.0

Shared TypeScript definitions for upcoming Octokit SDK

Gathering detailed insights and metrics for @octokit/types

@octokit/types - 14.1.0 | npmpackage.info

@octokit/types

Shared TypeScript definitions for Octokit projects

14.1.0

146

MIT

TypeScript

258.53 kB

6.3

Installations

npm install @octokit/types

Developer Guide

BETA

Typescript

Yes

Module System

N/A

Node Version

22.15.0

NPM Version

10.5.2 Score

99.6

Supply Chain

Quality

84.9

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

4

Total

577

Closed

25

Merged

548

Issues

Open

11

Total

97

Closed

86

Releases

220

v14.1.0

Updated on May 25, 2025

v14.0.0

Updated on Apr 10, 2025

v13.10.0

Updated on Mar 18, 2025

v13.9.0

Updated on Mar 18, 2025

v13.8.1

Updated on Mar 18, 2025

v13.8.0

Updated on Jan 31, 2025

View All 220 releases

Languages

TypeScript

JavaScript

TypeScript (98.38%)

JavaScript (1.62%)

Developer

octokit

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

146 Stars

655 Commits

33 Forks

6 Watchers

8 Branches

29 Contributors

Updated on Jun 03, 2025

Maintainers

View All 29 Contributors

Package Meta Information

Latest Version

14.1.0

Package Id

@octokit/types@14.1.0

Unpacked Size

258.53 kB

Size

28.90 kB

File Count

NPM Version

10.5.2

Node Version

22.15.0

Published on

May 25, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

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

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.

4

Maintained

Determines if the project is "actively maintained".

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/add_to_octokit_project.yml:20: 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: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:27: 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/release.yml:28: 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:39: 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:11: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/types.ts/update.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/types.ts/update.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update.yml:17: 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:33: 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:23
Info: 2 out of 14 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 5 third-party GitHubAction dependencies pinned
Info: 3 out of 4 npmCommand dependencies pinned

3

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

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

6.3

/10

Last Scanned on 2025-07-07

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