14.1.0 • Published 5 months ago

@octokit/types v14.1.0

Weekly downloads
5,855,581
License
MIT
Repository
github
Last release
5 months ago

types.ts

Shared TypeScript definitions for Octokit projects

@latest Build Status

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

@octokit/request-error@octokit/endpoint@octokit/plugin-rest-endpoint-methods@octokit/request@octokit/plugin-paginate-rest@octokit/graphql@octokit/coretest-dsm-github-harmonizer@joshpress/git-cms@baoshan/octokit_auth-oauth-user-client.js@knapsack/github-api@everything-registry/sub-chunk-676tapp-registrantsyncd-hookswonjin-actionsvstest-oct1framework-detect-packageisobotimput-cmsmeow-cms@wbce/orbits-fuel@ubiquity-os/plugin-sdk@ubiquity-os/ubiquity-os-kernel@ubq-mentlegen/plugin-sdk@yankeeinlondon/repo-info@zaproxy/actions-common-scansapikit-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.diytime-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-githubupdate-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-requestsnaive-gh-eventsopenlineosharkoctokit-plugin-create-pull-requestoctokit-plugin-unique-issueoctokitoctokit-auth-octotaskoctokit-auth-probotoctotaskrelgen-corerepo-retrieverprobotprovisiontui-david-kengskubagithub-takeoutgithub-commit-checkgithub-discussions-fetchergithub-harmonizergh-actions-language-servergh-all-reposcnp-utilscli-gconfcreate-freoncreate-npm-packagescrv-clida-tru-mvp-botbingo-requestsbolt-it-testbolt.diygas-appgas-github@shiftmedia/release-toolsellie-clifixdiscover@solomonai/trpc@solomonai/trpc-clerk@denizhoxha/probot@mahnunchik/publisher-github@martina-if/plugin-cloudbuild@deviavir/actions-common-scans
14.1.0

5 months ago

13.10.0

7 months ago

13.9.0

7 months ago

14.0.0

6 months ago

13.7.0

9 months ago

13.8.0

9 months ago

13.8.1

7 months ago

13.6.2

11 months ago

13.6.3

9 months ago

13.6.0

1 year ago

13.6.1

1 year ago

13.5.1

1 year ago

13.5.0

1 year ago

13.4.1

2 years ago

13.3.0

2 years ago

13.4.0

2 years ago

13.2.0

2 years ago

13.1.0

2 years ago

13.0.0

2 years ago

12.6.0

2 years ago

12.5.0

2 years ago

12.4.0

2 years ago

10.1.0-beta.1

2 years ago

12.3.0

2 years ago

11.0.0

2 years ago

12.0.0

2 years ago

12.0.1

2 years ago

11.1.0

2 years ago

12.2.0

2 years ago

12.1.0

2 years ago

12.1.1

2 years ago

10.0.0

2 years ago

9.2.3

2 years ago

9.2.2

2 years ago

9.2.1

2 years ago

9.3.0-beta.1

2 years ago

9.3.2

2 years ago

9.3.1

2 years ago

9.3.0

2 years ago

10.0.0-beta.2

2 years ago

10.0.0-beta.1

2 years ago

9.1.4

2 years ago

9.1.3

2 years ago

9.1.2

2 years ago

9.1.1

2 years ago

9.1.0

2 years ago

9.2.0

2 years ago

8.1.0

3 years ago

8.1.1

3 years ago

8.2.1

3 years ago

8.2.0

3 years ago

9.0.0

3 years ago

7.5.1

3 years ago

8.0.0

3 years ago

7.3.1

3 years ago

7.3.0

3 years ago

7.4.0

3 years ago

7.5.0

3 years ago

7.2.0

3 years ago

6.36.0

3 years ago

7.0.0

3 years ago

6.39.0

3 years ago

6.35.0

3 years ago

6.41.0

3 years ago

6.38.1

3 years ago

6.38.2

3 years ago

7.1.1

3 years ago

7.1.0

3 years ago

6.38.0

3 years ago

6.40.0

3 years ago

6.37.0

3 years ago

6.37.1

3 years ago

6.32.0

4 years ago

6.34.0

4 years ago

6.33.0

4 years ago

6.31.2

4 years ago

6.31.3

4 years ago

6.31.1

4 years ago

6.31.0

4 years ago

6.29.0

4 years ago

6.30.0

4 years ago

6.28.0

4 years ago

6.28.1

4 years ago

6.27.2

4 years ago

6.27.1

4 years ago

6.27.0

4 years ago

6.26.0

4 years ago

6.25.0

4 years ago

6.24.0

4 years ago

6.23.0

4 years ago

6.22.0

4 years ago

6.21.1

4 years ago

6.20.0

4 years ago

6.19.1

4 years ago

6.21.0

4 years ago

6.19.0

4 years ago

6.18.1

4 years ago

6.17.4

4 years ago

6.18.0

4 years ago

6.17.2

4 years ago

6.17.3

4 years ago

6.17.0

4 years ago

6.17.1

4 years ago

6.16.7

4 years ago

6.16.6

4 years ago

6.16.5

4 years ago

6.16.3

4 years ago

6.16.4

4 years ago

6.16.1

4 years ago

6.16.2

4 years ago

6.13.2

4 years ago

6.13.1

4 years ago

6.16.0

4 years ago

6.15.0

4 years ago

6.14.2

4 years ago

6.14.1

4 years ago

6.14.0

4 years ago

6.13.0

5 years ago

6.12.2

5 years ago

6.12.1

5 years ago

6.12.0

5 years ago

6.11.2

5 years ago

6.11.1

5 years ago

6.11.0

5 years ago

6.10.1

5 years ago

6.10.0

5 years ago

6.9.0

5 years ago

6.8.5

5 years ago

6.8.4

5 years ago

6.8.3

5 years ago

6.8.1

5 years ago

6.8.0

5 years ago

6.8.2

5 years ago

6.7.1

5 years ago

6.7.0

5 years ago

6.6.0

5 years ago

6.5.2

5 years ago

6.5.1

5 years ago

6.5.3

5 years ago

6.5.0

5 years ago

6.4.2

5 years ago

6.4.1

5 years ago

6.4.0

5 years ago

6.3.2

5 years ago

6.3.1

5 years ago

6.3.0

5 years ago

6.2.1

5 years ago

6.2.0

5 years ago

6.1.2

5 years ago

6.1.1

5 years ago

6.1.0

5 years ago

6.0.3

5 years ago

6.0.2

5 years ago

6.0.1

5 years ago

6.0.0

5 years ago

5.5.0

5 years ago

5.4.1

5 years ago

5.4.0

5 years ago

5.3.0

5 years ago

5.2.1

5 years ago

5.2.0

5 years ago

5.1.2

5 years ago

5.1.1

5 years ago

5.1.0

5 years ago

5.0.1

5 years ago

5.0.0

5 years ago

4.1.10

5 years ago

4.1.9

5 years ago

4.1.8

5 years ago

4.1.7

5 years ago

4.1.6

5 years ago

4.1.5

5 years ago

4.1.4

5 years ago

4.1.3

5 years ago

4.1.2

5 years ago

4.1.0

5 years ago

4.1.1

5 years ago

4.0.2

5 years ago

4.0.1

5 years ago

3.0.3

5 years ago

4.0.0

5 years ago

3.0.2

5 years ago

3.0.1

5 years ago

3.0.0

5 years ago

2.16.2

5 years ago

2.16.1

5 years ago

2.16.0

5 years ago

2.15.0

5 years ago

2.14.0

5 years ago

2.13.0

5 years ago

2.12.2

5 years ago

2.12.0

5 years ago

2.12.1

5 years ago

2.11.0

6 years ago

2.11.1

6 years ago

2.10.0

6 years ago

2.9.0

6 years ago

2.8.2

6 years ago

2.8.1

6 years ago

2.8.0

6 years ago

2.8.0-beta.3

6 years ago

2.8.0-beta.2

6 years ago

2.7.1

6 years ago

2.8.0-beta.1

6 years ago

2.7.0

6 years ago

2.6.0

6 years ago

2.5.1

6 years ago

2.5.0

6 years ago

2.4.0

6 years ago

2.3.2

6 years ago

2.3.0

6 years ago

2.3.1

6 years ago

2.2.0

6 years ago

2.1.1

6 years ago

2.1.0

6 years ago

2.0.2

6 years ago

2.0.1

6 years ago

2.0.0

6 years ago

1.1.0

6 years ago

1.0.0

6 years ago