在开发前端项目中,经常会需要获取 GitHub 组织或者用户的成员列表。虽然可以通过 GitHub 提供的 API 进行获取,但每次都需要手动操作,十分麻烦。于是,开发者 @rollodeqc 开发了一个 npm 包 rollodeqc-gh-members
,可以方便地获取 GitHub 用户和组织的成员列表。
安装
在终端中输入以下命令进行安装:
npm install rollodeqc-gh-members
安装完成后,可以在项目中引入该包:
const githubMembers = require('rollodeqc-gh-members');
使用
rollodeqc-gh-members
提供了两个 API:getUserMembers
用于获取指定用户的成员列表,getOrganizationMembers
用于获取指定组织的成员列表。
获取用户成员列表
getUserMembers
方法使用起来十分简单,在参数中传入一个字符串代表目标 GitHub 用户的 username 即可。
const members = await githubMembers.getUserMembers('username');
该方法返回一个 Promise 对象,返回的结果是包含成员信息的数组,格式如下:
[ { login: 'xxx', avatar_url: 'xxx', …… }, …… ]
获取组织成员列表
getOrganizationMembers
方法使用起来也很简单,只需传入一个字符串表示目标 GitHub 组织的名称即可。
const members = await githubMembers.getOrganizationMembers('org-name');
同样返回一个 Promise 对象,包含成员信息的数组。
示例
以获取某一 GitHub 组织下的成员列表为例,这里是一个完整的示例代码:
-- -------------------- ---- ------- ----- ------------- - -------------------------------- ----- -------- ------------ - --- - ----- ------- - ----- ------------------------------------------------- --------------------- - ----- ----- - ----------------- - - -------------
总结
通过 rollodeqc-gh-members
包,我们可以方便地获取到 GitHub 用户和组织的成员列表。使用起来简单,功能强大,可以大大提升开发效率。希望这篇文章对大家有帮助,更多细节和 API 详见 GitHub 仓库。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6006737a890c4f7277584125