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

$3

``ts
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"] {
// ...
}
`

$3

`ts
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