类型.ts

Octokit 项目的共享类型脚本定义

• 使用量
• 实例
  • 为 REST API 端点获取参数和响应数据类型
  • 从端点方法获取响应类型
• 捐款
• 许可证

使用量

参见所有导出类型 https://octokit.github.io/ types.ts

实例

为 REST API 端点获取参数和响应数据类型

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

从端点方法获取响应类型

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
>;

捐款

见 捐款额

许可证

麻省理工学院