@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/plugin-rest-endpoint-methods @octokit/request @octokit/endpoint @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 tapp-registrant syncd-hooks wonjin-actions vstest-oct1 @doyokit/core @dog-hero/gihub-check-run framework-detect-package isobot time-line-prolink @api3/commons @apwide/golive-github-actions @anakz/backstage-plugin-library-check @adrian.insua/octokit-plugin-create-pull-request @aimcodes/graphql @babblebot/cli @beeker-tech/cli @broadshield/github-actions-core-typed-inputs @broadshield/github-actions-octokit-hydrated @broadshield/github-actions-workflow-marie-kondo @actions/languageserver @bowtie/ts-github @denizhoxha/probot @deviavir/actions-common-scans @digital-garden-builder/git-cms @dashlog/core update-existing-release @guardian/master-to-main @heliosphere/deploy-script @haruyukilxz/tools @hackney/mtfh-cli @google-automations/git-file-utils @georgexu99/publisher-github @githubnext/blocks @github-automations/bot-config-utils @gittrends-app/core @infracost/compost @infinitebrahmanuniverse/nolb-_oc @kozmoai/backstage-plugin-github-insights @kozmoai/backstage-plugin-github-pull-requests @mahnunchik/publisher-github @mgga/auth-app @martina-if/plugin-cloudbuild @electron-forge/publisher-github @mofunetive/api @justforlxz/tools @kie/build-chain-action @keyrxng/ubiquity-os-kernel @jbrunton/gha-installer @octokit/action @octokit/app @octokit/auth-action @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 @olfi01/languageserver @rdiaz/meli-github @rdiaz/meli-releaser @ploys/deployments-core @probot-ng/core @probot-ng/octokit-auth-probot-ng @opencollective/auth-simple-oauth-app @nu-art/github @nqkdev/octokit-plugin-create-pull-request @octokit/auth-app @octokit/auth-basic @octokit/auth-oauth-app @octokit/auth-oauth-device @octokit/auth-oauth-user @octokit/auth-unauthenticated @octokit/oauth-methods @pensar/comply @shiftmedia/release-tools @security-alert/share @roadiehq/backstage-plugin-github-insights @roadiehq/backstage-plugin-github-pull-requests naive-gh-events openline oshark octokit-plugin-create-pull-request octokit-plugin-unique-issue octokit octokit-auth-octotask octokit-auth-probot octotask relgen-core

9 months ago

8 months ago

9 months ago

1 year ago

1 year ago

1 year ago

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

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

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

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

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