# @octokit/types 中文文档

规范地址：https://npmcn.com/package/%40octokit/types/

版本：18\.0\.0
npm 元数据更新时间：2026-08-29T16:03:59.676Z
中文译文更新时间：2026-11-05T15:50:40.276Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40octokit/types
原文对照：https://npmcn.com/package/%40octokit/types/?lang=original
项目主页：https://github.com/octokit/types.ts#readme
源码仓库：https://github.com/octokit/types.ts

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：324 kB，24 个文件
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2019-10-24T05:09:11.075Z
- 最新版本发布：2026-08-29T16:03:59.320Z
- 近 30 天下载量：317731775（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：226（近 12 个月 2 个）

## 中文简介

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

## 安装

```sh
npm install @octokit/types
```

也可以使用：`pnpm add @octokit/types`、`yarn add @octokit/types`、`bun add @octokit/types`

## README

# 类型.ts

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

[![@latest](https://img.shields.io/npm/v/@octokit/types.svg)](https://www.npmjs.com/package/@octokit/types) [![Build Status](https://github.com/octokit/types.ts/workflows/Test/badge.svg)](https://github.com/octokit/types.ts/actions?workflow=Test)

-   [使用量](https://npmcn.com/package/%40octokit/types/#readme-usage)
-   [实例](https://npmcn.com/package/%40octokit/types/#readme-examples)
    -   [为 REST API 端点获取参数和响应数据类型](https://npmcn.com/package/%40octokit/types/#readme-get-parameter-and-response-data-types-for-a-rest-api-endpoint)
    -   [从端点方法获取响应类型](https://npmcn.com/package/%40octokit/types/#readme-get-response-types-from-endpoint-methods)
-   [捐款](https://npmcn.com/package/%40octokit/types/#readme-contributing)
-   [许可证](https://npmcn.com/package/%40octokit/types/#readme-license)

## 使用量

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

## 实例

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

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

### 从端点方法获取响应类型

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

## 捐款

见 [捐款额](https://npmcn.com/package/%40octokit/types/CONTRIBUTING.md)

## 许可证

[麻省理工学院](https://npmcn.com/package/%40octokit/types/LICENSE)

## 常见问题

### @octokit/types 是什么？

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

### 如何安装 @octokit/types？

在项目目录运行 npm install @octokit/types，或使用 pnpm add / yarn add / bun add。

### @octokit/types 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @octokit/types 可以商用吗？

@octokit/types 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @octokit/types 的下载量有多少？

根据 npm 官方下载统计，@octokit/types 在 2026/10/07 – 2026/11/05 这 30 天内被下载 317,731,775 次，日均约 10,591,059 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @octokit/types 还在维护吗？

最新版本 18\.0\.0 发布于 2026/08/30（2 个月前）；至今共发布 226 个版本，其中过去 12 个月发布了 2 个；首次发布于 2019/10/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。