npm 包 get-repo-stargazers-count 使用教程

前言

有时作为前端开发者，我们可能需要获取一个项目在 Github 上的 Star 数。为了方便获取这个数，我们可以使用一个轻量级的 npm 包，叫做 get-repo-stargazers-count。它可以非常轻松地帮助我们获取 Github 仓库的 Star 数。

在本文中，我们将学习如何使用这个 npm 包并拓展我们的前端技能。

什么是 get-repo-stargazers-count

get-repo-stargazers-count 是一个轻量级的 npm 包，它可以帮助我们快速地获取 Github 仓库的 Star 数。这个包简化了我们通过 Github API 发送请求并解析响应的流程，使得我们可以省去很多琐碎的细节。

如何安装 get-repo-stargazers-count

我们可以使用 npm 来安装 get-repo-stargazers-count 包。在终端中输入以下命令：

npm install get-repo-stargazers-count

如何使用 get-repo-stargazers-count

安装完成之后，我们可以简单地引入 get-repo-stargazers-count 包，并通过给定的接口获取一个 Github 仓库的 Star 数量。

const getRepoStarCount = require('get-repo-stargazers-count');

getRepoStarCount('owner', 'repo')
  .then((count) => console.log(count))
  .catch((err) => console.error(err));

在这个示例中，我们传入了 Github 仓库的 owner 和 repo 名称，get-repo-stargazers-count 包会返回一个 Promise 对象，成功的回调会包含 Github 仓库的 Star 数量。

拓展

我们还可以通过 get-repo-stargazers-count 包调用 Github API 的更多接口来获取更多有用的信息。比如，我们可以获取 Github 仓库的 forks 数量，issue 数量等等。

以下是一个示例，演示了如何获取 Github 仓库的 forks 数量：

const { get } = require('get-repo-stargazers-count');

get('repos/owner/repo/forks')
  .then((forks) => console.log(forks))
  .catch((err) => console.error(err));

在这个示例中，我们使用了 get 函数，传入了一个 Github API 的路径。这个函数返回了一个 Promise 对象，成功的回调包含了我们所需要的信息。

值得一提的是，这个包支持返回 Promise 以及 Node.js 回调函数两种形式。所以，如果你喜欢回调函数，也可以尝试使用它。

结论

在本文中，我们学会了如何使用 get-repo-stargazers-count npm 包来获取 Github 仓库的 Star 数。我们还拓展了我们的前端技能，学会了如何通过调用 Github API 来获取更多有用的信息。

get-repo-stargazers-count 就是那个小小的 npm 包，但它却为我们提供了精确、有用的数据，从而使我们的前端工作更加高效和好玩。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005589e81e8991b448d5e73