在进行前端开发时，我们可能需要在项目中使用到 Github API，那么如何在 TypeScript 项目中使用 Github API 呢？这个时候，我们可以使用 npm 包 @types/github。那么本篇文章就会为大家详细介绍该 npm 包的使用教程，包括安装和使用以及示例代码等。
1. 安装
在使用 @types/github 时，我们需要首先安装该 npm 包，可以通过以下命令进行安装：
npm install --save-dev @types/github
注意：需要使用 --save-dev 参数将其安装为 devDependencies。
2. 引入
安装之后，我们需要在代码中引入该 npm 包，可以通过以下方式进行引入：
import { Octokit } from '@octokit/rest';3. 使用
引入后，我们就可以使用该 npm 包提供的 GitHub API 了。其中，Octokit 类提供了一系列 REST API 方法，下面我们举一个例子来说明如何使用该类进行查询 GitHub 指定用户的公开仓库信息。
-- -------------------- ---- -------
------ - ------- - ---- ----------------
----- -------- ---------- -
----- ------- - --- ----------
----- ------ - ----- ---------------------------
--------- -----
---
-------------------------
-
-----------上述代码中，我们使用 Octokit 类的 listForUser 方法，传递一个对象参数，包括查询的用户名。该方法会查询用户的所有公开仓库信息，返回一个 Promise 对象，通过 await 关键字等待该 Promise 对象的完成并获取数据。
4. 总结
本篇文章主要介绍了 npm 包 @types/github 的安装及使用方法，并且针对 Github API 的一个示例进行了详细展示。通过学习本文，相信大家已经掌握了如何在 TypeScript 项目中使用 Github API。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedbe6ab5cbfe1ea0611b66