@octokit/types NPM

types.ts

Shared TypeScript definitions for Octokit projects

Usage

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

Examples

Get parameter and response data types for a REST API endpoint

import { Endpoints } from "@octokit/types";

type listUserReposParameters =
  Endpoints["GET /repos/{owner}/{repo}"]["parameters"];
type listUserReposResponse = Endpoints["GET /repos/{owner}/{repo}"]["response"];

async function listRepos(
  options: listUserReposParameters,
): listUserReposResponse["data"] {
  // ...
}

Get response types from endpoint methods

import {
  GetResponseTypeFromEndpointMethod,
  GetResponseDataTypeFromEndpointMethod,
} from "@octokit/types";
import { Octokit } from "@octokit/rest";

const octokit = new Octokit();
type CreateLabelResponseType = GetResponseTypeFromEndpointMethod<
  typeof octokit.issues.createLabel
>;
type CreateLabelResponseDataType = GetResponseDataTypeFromEndpointMethod<
  typeof octokit.issues.createLabel
>;

Contributing

See CONTRIBUTING.md

License

MIT

github api sdk toolkit typescript

@octokit/openapi-types

@octokit/request-error @octokit/endpoint @octokit/request @octokit/plugin-rest-endpoint-methods @octokit/plugin-paginate-rest @octokit/graphql @octokit/core test-dsm-github-harmonizer @joshpress/git-cms @baoshan/octokit_auth-oauth-user-client.js @knapsack/github-api @everything-registry/sub-chunk-676 tapp-registrant syncd-hooks wonjin-actions vstest-oct1 framework-detect-package isobot imput-cms meow-cms @wbce/orbits-fuel @ubiquity-os/plugin-sdk @ubiquity-os/ubiquity-os-kernel @ubq-mentlegen/plugin-sdk @yankeeinlondon/repo-info @zaproxy/actions-common-scans apikit-core @google-automations/git-file-utils @guardian/master-to-main @hackney/mtfh-cli @haruyukilxz/tools time-line-prolink update-existing-release @infinitebrahmanuniverse/nolb-_oc naive-gh-events openline oshark octokit-plugin-create-pull-request octokit-plugin-unique-issue octokit octokit-auth-octotask octokit-auth-probot octotask relgen-core repo-retriever probot provisiontui-david-keng skuba github-takeout github-commit-check github-discussions-fetcher github-harmonizer gh-actions-language-server gh-all-repos @octokit/oauth-methods @octokit/plugin-throttling @octokit/plugin-create-or-update-text-file @octokit/plugin-enterprise-cloud @octokit/plugin-enterprise-compatibility @octokit/plugin-enterprise-server @octokit/plugin-retry @octokit/auth-action @octokit/auth-app @octokit/auth-basic @octokit/auth-oauth-app @octokit/auth-oauth-device @octokit/auth-oauth-user @octokit/auth-unauthenticated @octokit/action @octokit/app @olfi01/languageserver @okcashpro/client-github @nqkdev/octokit-plugin-create-pull-request @nu-art/github @opencollective/auth-simple-oauth-app @georgexu99/publisher-github @github-automations/bot-config-utils @gittrends-app/core @githubnext/blocks @heliosphere/deploy-script @infracost/compost @interval-network/cli @pensar/comply @ploys/deployments-core gas-app gas-github @shiftmedia/release-tools ellie-cli fixdiscover @actions/languageserver @probot-ng/core @probot-ng/octokit-auth-probot-ng @broadshield/github-actions-core-typed-inputs @broadshield/github-actions-octokit-hydrated @broadshield/github-actions-workflow-marie-kondo @beeker-tech/cli @babblebot/cli @bowtie/ts-github cnp-utils cli-gconf

6 months ago

8 months ago

8 months ago

7 months ago

10 months ago

9 months ago

8 months ago

12 months ago

10 months ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago