npm 包 repogitjs-api 使用教程

介绍

repogitjs-api 是一个可以获取 Github 上仓库信息的简单易用的 npm 包，它基于 Github 官方 API，可以获取到一些有用的信息，如 stars，forks 等等。在本文中，我们将详细介绍如何使用 repogitjs-api。

安装和使用

安装

要安装 repogitjs-api，你需要在控制台中输入下面的命令：

npm install repogitjs-api

使用

在你的 JS 文件或者 Node.js 项目中，你需要导入 repogitjs-api：

const RepoGit = require('repogitjs-api')

然后，你可以使用 RepoGit 来完成从 Github 获取数据的操作。

获取 Github 仓库信息的方法

getUserInfo

获取 Github 用户的信息。

RepoGit.getUserInfo(username, token)
  .then(user => {
    console.log(user)
  })
  .catch(err => {
    console.log(err)
  })

参数：

• username: Github 用户名
• token: Github 的 Token

返回：

• 如果获取成功，返回用户信息；
• 如果获取失败，返回错误信息。

getUserRepos

获取 Github 用户的所有仓库。

RepoGit.getUserRepos(username, token)
  .then(repos => {
    console.log(repos)
  })
  .catch(err => {
    console.log(err)
  })

参数：

• username: Github 用户名
• token: Github 的 Token

返回：

• 如果获取成功，返回仓库列表信息；
• 如果获取失败，返回错误信息。

getRepo

获取 Github 单个仓库的信息。

RepoGit.getRepo(username, repoName, token)
  .then(repo => {
    console.log(repo)
  })
  .catch(err => {
    console.log(err)
  })

参数：

• username: Github 用户名
• repoName: 仓库名称
• token: Github 的 Token

返回：

• 如果获取成功，返回仓库信息；
• 如果获取失败，返回错误信息。

getRepoLastCommit

获取 Github 单个仓库的 last commit 信息。

RepoGit.getRepoLastCommit(username, repoName, token)
  .then(commit => {
    console.log(commit)
  })
  .catch(err => {
    console.log(err)
  })

参数：

• username: Github 用户名
• repoName: 仓库名称
• token: Github 的 Token

返回：

• 如果获取成功，返回 commit 信息；
• 如果获取失败，返回错误信息。

getRepoLanguages

获取 Github 单个仓库的编程语言信息。

RepoGit.getRepoLanguages(username, repoName, token)
  .then(languages => {
    console.log(languages)
  })
  .catch(err => {
    console.log(err)
  })

参数：

• username: Github 用户名
• repoName: 仓库名称
• token: Github 的 Token

返回：

• 如果获取成功，返回编程语言信息；
• 如果获取失败，返回错误信息。

示例代码

下面是一个完整的示例代码：

-- -------------------- ---- -------
----- ------- - ------------------------

-- -- ----------- - ------ --------
-------------------------------- ------- -------
  ---------- -- -
    -----------------
  --
  ---------- -- -
    ----------------
  --

-- -- ------------ - ------ -----------
--------------------------------- ------- -------
  ----------- -- -
    ------------------
  --
  ---------- -- -
    ----------------
  --

-- -- ------- - ------ --------
---------------------------- ------- ------- -------
  ---------- -- -
    -----------------
  --
  ---------- -- -
    ----------------
  --

-- -- ----------------- - ------ ------- ---- ------ --
-------------------------------------- ------- ------- -------
  ------------ -- -
    -------------------
  --
  ---------- -- -
    ----------------
  --

-- -- ---------------- - ------ -------------
------------------------------------- ------- ------- -------
  --------------- -- -
    ----------------------
  --
  ---------- -- -
    ----------------
  --

总结

通过本文，你可以了解到如何使用 repogitjs-api 包从 Github 获取仓库信息。repogitjs-api 是一个十分简单易用的 npm 包，可以帮助你轻松地获取 Github 上的仓库信息。希望本文能够对你有所帮助！

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