@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/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 @actions/languageserver @aimcodes/graphql @aidc-toolkit/dev @ai16z/client-github @haruyukilxz/tools @adrian.insua/octokit-plugin-create-pull-request @codacus/bolt.diy time-line-prolink @babblebot/cli @beeker-tech/cli @broadshield/github-actions-core-typed-inputs @broadshield/github-actions-octokit-hydrated @broadshield/github-actions-workflow-marie-kondo @bowtie/ts-github update-existing-release @infinitebrahmanuniverse/nolb-_oc @kozmoai/backstage-plugin-github-insights @kozmoai/backstage-plugin-github-pull-requests @mofunetive/api @kie/build-chain-action @keyrxng/ubiquity-os-kernel @rdiaz/meli-github @rdiaz/meli-releaser @ploys/deployments-core @probot-ng/core @probot-ng/octokit-auth-probot-ng @pensar/comply @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 repo-retriever probot provisiontui-david-keng skuba github-takeout github-commit-check github-discussions-fetcher github-harmonizer gh-actions-language-server gh-all-repos cnp-utils cli-gconf create-freon create-npm-packages crv-cli da-tru-mvp-bot bingo-requests bolt-it-test bolt.diy gas-app gas-github @shiftmedia/release-tools ellie-cli fixdiscover @solomonai/trpc @solomonai/trpc-clerk @denizhoxha/probot @mahnunchik/publisher-github @martina-if/plugin-cloudbuild @deviavir/actions-common-scans

5 months ago

7 months ago

7 months ago

6 months ago

9 months ago

9 months ago

7 months ago

11 months ago

9 months 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

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

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

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