介绍
gh-account-exists 是一个用于检查 GitHub 上是否存在用户的 npm 包。该包额外提供了基于 OAuth2 的认证功能。
在进行一些与 GitHub 相关的操作时，我们可能需要检查目标用户是否存在。这时，gh-account-exists 可以帮助我们快速地获取该信息。
安装
使用 npm 安装 gh-account-exists：
npm install gh-account-exists
使用
引入
在代码文件中引入 gh-account-exists：
const ghAccountExists = require('gh-account-exists');配置
使用 ghAccountExists.config 方法配置 gh-account-exists：
ghAccountExists.config({
clientId: 'xxxxxxxxxxxxxxx', // GitHub 应用的 Client ID
clientSecret: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', // GitHub 应用的 Client Secret
scope: 'user:email' // GitHub OAuth2 授权范围，可以不填，默认为 user
});检查用户是否存在
使用 ghAccountExists.exists 方法检查用户是否存在：
ghAccountExists.exists('octocat').then((result) => {
console.log(result); // true
}).catch((error) => {
console.log(error); // 如果出现错误，可以在此处处理异常
});获取用户信息
使用 ghAccountExists.getUserInfo 方法获取用户信息：
ghAccountExists.getUserInfo('octocat').then((userInfo) => {
console.log(userInfo); // 格式为 { login: 'octocat', id: 1, ... }
}).catch((error) => {
console.log(error); // 如果出现错误，可以在此处处理异常
});异步获取用户信息
使用 ghAccountExists.withUserInfo 方法在存在用户时获取用户信息：
ghAccountExists.withUserInfo('octocat').then(({ exists, userInfo }) => {
if (exists) {
console.log(userInfo); // 格式为 { login: 'octocat', id: 1, ... }
}
}).catch((error) => {
console.log(error); // 如果出现错误，可以在此处处理异常
});检查用户是否存在并获取用户信息
使用 ghAccountExists.existWithUserInfo 方法检查用户是否存在并获取用户信息：
ghAccountExists.existWithUserInfo('octocat').then(({ exists, userInfo }) => {
if (exists) {
console.log(userInfo); // 格式为 { login: 'octocat', id: 1, ... }
}
}).catch((error) => {
console.log(error); // 如果出现错误，可以在此处处理异常
});示例
以下是一个简单的示例，该示例展示了如何使用 gh-account-exists 在终端中检查目标用户是否存在：
-- -------------------- ---- -------
----- --------------- - -----------------------------
------------------------
--------- ------------------ -- ------ --- ------ --
------------- ------------------------------------------- -- ------ --- ------ ------
------ ------------ -- ------ ------ ------------- ----
---
---------------------------------------------------- ------- -------- -- -- -
-- -------- -
------------------------------ -- ----------
- ---- -
------------------------------ -- --- ----------
-
---------------- -- -
-------------------
---执行代码后，终端将打印出目标用户是否存在的提示信息。
结论
gh-account-exists 为检查 GitHub 用户是否存在提供了一个快速而简洁的解决方案。同时，它还提供了一个灵活的 API，可根据不同的使用场景进行相关的配置和操作。即便是使用 OAuth2 认证，操作也是相当简单的。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600551cc81e8991b448cf2f9