@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/plugin-rest-endpoint-methods @octokit/request @octokit/plugin-paginate-rest @octokit/core @octokit/graphql test-dsm-github-harmonizer @joshpress/git-cms @baoshan/octokit_auth-oauth-user-client.js @knapsack/github-api @everything-registry/sub-chunk-676 vstest-oct1 @georgexu99/publisher-github update-existing-release @heliosphere/deploy-script @google-automations/git-file-utils @githubnext/blocks @martina-if/plugin-cloudbuild time-line-prolink skuba wonjin-actions @justforlxz/tools @kozmoai/backstage-plugin-github-insights @kozmoai/backstage-plugin-github-pull-requests @lix-js/client @github-automations/bot-config-utils @infracost/compost ellie-cli @nu-art/github @mofunetive/api @olfi01/languageserver @nqkdev/octokit-plugin-create-pull-request @octokit/auth-unauthenticated @octokit/action @octokit/app @octokit/auth-action @octokit/auth-app @octokit/auth-basic @octokit/auth-oauth-app @octokit/auth-oauth-device @octokit/auth-oauth-user @octokit/oauth-methods @octokit/plugin-create-or-update-text-file @octokit/plugin-enterprise-cloud @octokit/plugin-enterprise-compatibility @octokit/plugin-enterprise-server @octokit/plugin-retry @octokit/plugin-throttling @opencollective/auth-simple-oauth-app @mgga/auth-app framework-detect-package @mahnunchik/publisher-github gcf-utils gas-app gas-github gh-all-repos github-harmonizer github-takeout @infinitebrahmanuniverse/nolb-_oc @kie/build-chain-action @rdiaz/meli-github @rdiaz/meli-releaser @roadiehq/backstage-plugin-github-insights @roadiehq/backstage-plugin-github-pull-requests imput-cms @haruyukilxz/tools @guardian/master-to-main @hackney/mtfh-cli @jbrunton/gha-installer @probot-ng/core @probot-ng/octokit-auth-probot-ng @security-alert/share @electron-forge/publisher-github @shiftmedia/release-tools @ploys/deployments-core naive-gh-events apikit-core @babblebot/cli @beeker-tech/cli @anakz/backstage-plugin-library-check @actions/languageserver @adrian.insua/octokit-plugin-create-pull-request @bowtie/ts-github @broadshield/github-actions-core-typed-inputs @broadshield/github-actions-octokit-hydrated @broadshield/github-actions-workflow-marie-kondo @yankeeinlondon/repo-info @aimcodes/graphql meow-cms @doyokit/core cnp-utils oshark openline @dog-hero/gihub-check-run @dashlog/core octokit-plugin-create-pull-request octokit octokit-auth-probot octokit-plugin-unique-issue

11 days ago

17 days ago

17 days ago

18 days ago

22 days ago

24 days ago

2 months ago

2 months ago

5 months ago

10 months ago

6 months ago

10 months ago

7 months ago

6 months ago

10 months ago

6 months ago

6 months ago

6 months ago

11 months ago

11 months ago

12 months ago

12 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

12 months ago

1 year ago

1 year 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

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

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

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

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