前言
npm 是一个 Node.js 包管理工具，gethub 则是一个基于 npm 的第三方模块，用于获取 Github 上的数据。在前端开发领域，gethub 能够帮助我们从 Github 上获取代码仓库、用户、组织等信息，以及提交历史、分支、标签等详细数据。本文将详细介绍 npm 包 gethub 的使用方式及示例代码，帮助大家更好地了解 gethub 的功能和实用性。
安装
在使用 gethub 之前，需要先安装 gethub 包。可以使用以下命令进行安装：
npm install gethub
安装完成后，就可以使用 require() 函数将 gethub 引入到项目中，以便在项目中使用它的功能。示例代码如下：
const gethub = require('gethub');使用
获取仓库信息
我们可以使用 getRepo() 函数来获取 Github 上的代码仓库信息。该函数接受一个参数，即 Github 的库名，返回结果为 Promise 对象，结果包含仓库的名称、描述、所有者信息、分支、提交记录等。
-- -------------------- ---- -------
--------------------------------
---------- -- -
----------------------- -- -----
------------------------------ -- - ------------ ---------- --- -------- ---------- ------- --- -------- ---- -----------
------------------------------ -- --------
--------------------------------- -- ------
----------------------------------- -- ------
--
---------- -- ------------------获取用户信息
我们可以使用 getUser() 函数来获取 Github 上的用户信息。该函数接受一个参数，即用户名，返回结果为 Promise 对象，结果包含用户的名称、描述、邮箱等信息。
gethub.getUser('octocat')
.then(user => {
console.log(user.name); // The Octocat
console.log(user.bio); // A humanoid robot living on earth
console.log(user.email); // null
})
.catch(err => console.log(err));获取组织信息
我们可以使用 getOrg() 函数来获取 Github 上的组织信息。该函数接受一个参数，即组织名，返回结果为 Promise 对象，结果包含组织的名称、描述、成员列表等信息。
gethub.getOrg('google')
.then(org => {
console.log(org.name); // Google
console.log(org.description); // Organizing the world's information and making it universally accessible and useful.
console.log(org.public_members_count); // 73831
})
.catch(err => console.log(err));获取提交记录
我们可以使用 getCommits() 函数来获取 Github 上的提交记录。该函数接受一个参数，即仓库名，返回结果为 Promise 对象，结果包含提交的 SHA、作者、时间等信息。
-- -------------------- ---- -------
-----------------------------------
------------- -- -
---------------------- -- -
-------------------------------- -- -------
------------------------ -- ----------------------------------------
----------------------------------- -- --------------------
---
--
---------- -- ------------------总结
在本文中，我们介绍了 npm 包 gethub 的使用方式及示例代码。通过对 gethub 的学习，我们可以更好地了解 Github 的数据，便于我们在前端应用程序中使用这些数据。gethub 的功能还有很多，大家可以参考其文档以了解更多用法。希望本文能够对大家学习和使用 gethub 有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/65201