@octokit/types
Shared TypeScript definitions for Octokit projects
Last updated 2 years ago by octokitbot .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ gnpm install @octokit/types 
SYNC missed versions from official npm registry.

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

Current Tags

  • 10.1.0-beta.1                                ...           beta (a year ago)
  • 12.5.0                                ...           latest (10 months ago)
  • 8.2.1                                ...           release-8.x (2 years ago)

200 Versions

  • 12.5.0                                ...           10 months ago
  • 12.4.0                                ...           a year ago
  • 12.3.0                                ...           a year ago
  • 12.2.0                                ...           a year ago
  • 12.1.1                                ...           a year ago
  • 12.1.0                                ...           a year ago
  • 12.0.1                                ...           a year ago
  • 12.0.0                                ...           a year ago
  • 11.1.0                                ...           a year ago
  • 11.0.0                                ...           a year ago
  • 10.1.0-beta.1                                ...           a year ago
  • 10.0.0                                ...           2 years ago
  • 9.3.2                                ...           2 years ago
  • 10.0.0-beta.2                                ...           2 years ago
  • 9.3.1                                ...           2 years ago
  • 9.3.0                                ...           2 years ago
  • 10.0.0-beta.1                                ...           2 years ago
  • 9.3.0-beta.1                                ...           2 years ago
  • 9.2.3                                ...           2 years ago
  • 9.2.2                                ...           2 years ago
  • 9.2.1                                ...           2 years ago
  • 9.2.0                                ...           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
  • 8.2.1                                ...           2 years ago
  • 9.0.0                                ...           2 years ago
  • 8.2.0                                ...           2 years ago
  • 8.1.1                                ...           2 years ago
  • 8.1.0                                ...           2 years ago
  • 8.0.0                                ...           2 years ago
  • 7.5.1                                ...           2 years ago
  • 7.5.0                                ...           2 years ago
  • 7.4.0                                ...           2 years ago
  • 7.3.1                                ...           2 years ago
  • 7.3.0                                ...           2 years ago
  • 7.2.0                                ...           2 years ago
  • 7.1.1                                ...           2 years ago
  • 7.1.0                                ...           2 years ago
  • 7.0.0                                ...           2 years ago
  • 6.41.0                                ...           2 years ago
  • 6.40.0                                ...           2 years ago
  • 6.39.0                                ...           2 years ago
  • 6.38.2                                ...           2 years ago
  • 6.38.1                                ...           2 years ago
  • 6.38.0                                ...           2 years ago
  • 6.37.1                                ...           2 years ago
  • 6.37.0                                ...           2 years ago
  • 6.36.0                                ...           2 years ago
  • 6.35.0                                ...           3 years ago
  • 6.34.0                                ...           3 years ago
  • 6.33.0                                ...           3 years ago
  • 6.32.0                                ...           3 years ago
  • 6.31.3                                ...           3 years ago
  • 6.31.2                                ...           3 years ago
  • 6.31.1                                ...           3 years ago
  • 6.31.0                                ...           3 years ago
  • 6.30.0                                ...           3 years ago
  • 6.29.0                                ...           3 years ago
  • 6.28.1                                ...           3 years ago
  • 6.28.0                                ...           3 years ago
  • 6.27.2                                ...           3 years ago
  • 6.27.1                                ...           3 years ago
  • 6.27.0                                ...           3 years ago
  • 6.26.0                                ...           3 years ago
  • 6.25.0                                ...           3 years ago
  • 6.24.0                                ...           3 years ago
  • 6.23.0                                ...           3 years ago
  • 6.22.0                                ...           3 years ago
  • 6.21.1                                ...           3 years ago
  • 6.21.0                                ...           3 years ago
  • 6.20.0                                ...           3 years ago
  • 6.19.1                                ...           3 years ago
  • 6.19.0                                ...           3 years ago
  • 6.18.1                                ...           3 years ago
  • 6.18.0                                ...           3 years ago
  • 6.17.4                                ...           3 years ago
  • 6.17.3                                ...           3 years ago
  • 6.17.2                                ...           3 years ago
  • 6.17.1                                ...           3 years ago
  • 6.17.0                                ...           3 years ago
  • 6.16.7                                ...           3 years ago
  • 6.16.6                                ...           3 years ago
  • 6.16.5                                ...           3 years ago
  • 6.16.4                                ...           4 years ago
  • 6.16.3                                ...           4 years ago
  • 6.16.2                                ...           4 years ago
  • 6.16.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.2                                ...           4 years ago
  • 6.13.1                                ...           4 years ago
  • 6.13.0                                ...           4 years ago
  • 6.12.2                                ...           4 years ago
  • 6.12.1                                ...           4 years ago
  • 6.12.0                                ...           4 years ago
  • 6.11.2                                ...           4 years ago
  • 6.11.1                                ...           4 years ago
  • 6.11.0                                ...           4 years ago
  • 6.10.1                                ...           4 years ago
  • 6.10.0                                ...           4 years ago
  • 6.9.0                                ...           4 years ago
  • 6.8.5                                ...           4 years ago
  • 6.8.4                                ...           4 years ago
  • 6.8.3                                ...           4 years ago
  • 6.8.2                                ...           4 years ago
  • 6.8.1                                ...           4 years ago
  • 6.8.0                                ...           4 years ago
  • 6.7.1                                ...           4 years ago
  • 6.7.0                                ...           4 years ago
  • 6.6.0                                ...           4 years ago
  • 6.5.3                                ...           4 years ago
  • 6.5.2                                ...           4 years ago
  • 6.5.1                                ...           4 years ago
  • 6.5.0                                ...           4 years ago
  • 6.4.2                                ...           4 years ago
  • 6.4.1                                ...           4 years ago
  • 6.4.0                                ...           4 years ago
  • 6.3.2                                ...           4 years ago
  • 6.3.1                                ...           4 years ago
  • 6.3.0                                ...           4 years ago
  • 6.2.1                                ...           4 years ago
  • 6.2.0                                ...           4 years ago
  • 6.1.2                                ...           4 years ago
  • 6.1.1                                ...           4 years ago
  • 6.1.0                                ...           4 years ago
  • 6.0.3                                ...           4 years ago
  • 6.0.2                                ...           4 years ago
  • 6.0.1                                ...           4 years ago
  • 6.0.0                                ...           4 years ago
  • 5.5.0                                ...           4 years ago
  • 5.4.1                                ...           4 years ago
  • 5.4.0                                ...           4 years ago
  • 5.3.0                                ...           4 years ago
  • 5.2.1                                ...           4 years ago
  • 5.2.0                                ...           4 years ago
  • 5.1.2                                ...           4 years ago
  • 5.1.1                                ...           4 years ago
  • 5.1.0                                ...           4 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.1                                ...           5 years ago
  • 4.1.0                                ...           5 years ago
  • 4.0.2                                ...           5 years ago
  • 4.0.1                                ...           5 years ago
  • 4.0.0                                ...           5 years ago
  • 3.0.3                                ...           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.1                                ...           5 years ago
  • 2.12.0                                ...           5 years ago
  • 2.11.1                                ...           5 years ago
  • 2.11.0                                ...           5 years ago
  • 2.10.0                                ...           5 years ago
  • 2.9.0                                ...           5 years ago
  • 2.8.2                                ...           5 years ago
  • 2.8.1                                ...           5 years ago
  • 2.8.0                                ...           5 years ago
  • 2.8.0-beta.3                                ...           5 years ago
  • 2.7.1                                ...           5 years ago
  • 2.8.0-beta.2                                ...           5 years ago
  • 2.8.0-beta.1                                ...           5 years ago
  • 2.7.0                                ...           5 years ago
  • 2.6.0                                ...           5 years ago
  • 2.5.1                                ...           5 years ago
  • 2.5.0                                ...           5 years ago
  • 2.4.0                                ...           5 years ago
  • 2.3.2                                ...           5 years ago
  • 2.3.1                                ...           5 years ago
  • 2.3.0                                ...           5 years ago
  • 2.2.0                                ...           5 years ago
  • 2.1.1                                ...           5 years ago
  • 2.1.0                                ...           5 years ago
  • 2.0.2                                ...           5 years ago
  • 2.0.1                                ...           5 years ago
  • 2.0.0                                ...           5 years ago
  • 1.1.0                                ...           5 years ago
  • 1.0.0                                ...           5 years ago

Copyright 2013 - present © cnpmjs.org | Home |