npm 包 github-basic 使用教程

在现今的前端开发中，使用第三方库和插件已经成为一项必不可少的技能。而 npm (Node Package Manager) 则是目前最常用的处理第三方类库的工具之一。在这篇文章中，我们将介绍一个非常实用的 npm 包：github-basic，它可以帮助我们快速地获取 GitHub 上的信息和操作。

什么是 github-basic

github-basic 是一款封装了 GitHub 的 API，以便于我们在应用中直接使用它的接口而无需了解过多的 API 细节。该 npm 包内部基于 Promises 对 GitHub 的 API 进行封装，提供了很方便的使用方式。

如何使用 github-basic

首先，要使用 github-basic，我们需要先安装它。在终端中使用以下命令即可：

npm install github-basic

安装完成后，我们需要引入该包：

const Github = require('github-basic');

或：

import Github from 'github-basic';

这样，我们就可以使用 Github 提供的方法了。

如何获取 GitHub 用户的 Profile 信息

Github 提供了一组 API 用于获取用户的 Profile 信息，其中最常用的为：

Github.getUser(username)

我们可以将需要查询的用户名作为参数传递给该方法，该方法返回一个 promise 对象，你需要使用 then() 方法处理异步的结果：

Github.getUser('octocat')
  .then(response => {
    console.log(response);
  })
  .catch(error => {
    console.log(error);
  });

打印结果如下：

{
  login: 'octocat',
  id: 1,
  ... 其他信息
}

如何获取 GitHub 用户的 Repositories 列表

使用 Github 的 API，我们可以轻松地获取某一 GitHub 用户的 Repositories 列表。

Github.getUserRepos(username, options = {})

其中 username 是你需要获取 Repositories 列表的用户的用户名，options 是可选参数，包含了 Repositories 的筛选条件、排序规则等等。

Github.getUserRepos('octocat', { sort: 'created', order: 'asc' })
  .then(response => {
    console.log(response);
  })
  .catch(error => {
    console.log(error);
  });

打印结果如下：

[{
  id: 1296269,
  name: "Hello-World",
  full_name: "octocat/Hello-World",
  ... 其他信息
}]

如何创建一个 GitHub Repository

使用 github-basic，你也可以实现创建 GitHub Repository 的功能。

Github.createRepo(token, owner, repository, description = '', isPrivate = false)

其中 token 是你的 GitHub 令牌，owner 是 Repository 的拥有者，repository 是 Repository 的名字，description 是可选的描述信息，isPrivate 表示 Repository 是否为私有仓库。

Github.createRepo('mytoken', 'octocat', 'new-repository')
  .then(response => {
    console.log(response);
  })
  .catch(error => {
    console.log(error);
  });

打印结果如下：

{
  id: 1296269,
  name: "new-repository",
  full_name: "octocat/new-repository",
  ... 其他信息
}

结束语

github-basic 是一个很实用的 npm 包，它可以让我们在开发过程中更加方便地获取 GitHub 用户信息和操作 Repository。在实际开发中，github-basic 的使用尤为重要，可以大大提高我们的开发效率。同时，也提醒我们在使用第三方库和插件时，需要审慎选择和正确使用，以避免出现安全问题和不规范使用等问题。

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