types.ts

Shared TypeScript definitions for Octokit projects

• Usage
• Examples
  • Get parameter and response data types for a REST API endpoint
  • Get response types from endpoint methods
• Contributing
• License

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

• 2.8.0-beta.3                                ...           beta (5 years ago)
• 9.0.0                                ...           latest (3 years ago)

15 Versions

• 8.2.1                                ...           3 years ago
• 9.0.0                                ...           3 years ago
• 8.0.0                                ...           3 years ago
• 6.41.0                                ...           3 years ago
• 7.5.0                                ...           3 years ago
• 6.34.0                                ...           4 years ago
• 6.27.0                                ...           4 years ago
• 4.1.10                                ...           5 years ago
• 5.5.0                                ...           5 years ago
• 6.12.2                                ...           4 years ago
• 2.16.2                                ...           5 years ago
• 2.8.0-beta.3                                ...           5 years ago
• 4.1.3                                ...           5 years ago
• 2.0.2                                ...           6 years ago
• 2.13.0                                ...           5 years ago