在前端开发中，我们经常需要获取一些与 GitHub 用户相关的信息，如头像、用户名、邮箱等。npm 提供了一个非常方便的包，可以轻松地获取这些信息，那就是 github-username。本文将介绍如何使用这个 npm 包。
安装
使用 npm 安装 github-username：
npm install github-username
使用方法
获取用户名
const ghUsername = require('github-username'); ghUsername('https://github.com/octocat').then(username => { console.log(username); // 'octocat' });
获取头像地址
const ghAvatar = require('github-username/lib/avatar'); ghAvatar('octocat').then(avatar => { console.log(avatar); // 'https://avatars.githubusercontent.com/u/583231?v=4' });
获取用户信息
-- -------------------- ---- ------- ----- ------ - ------------------------------------ --------------------------- -- - ------------------ -- - -- ------ ---------- -- --- ------- -- ----------- ----------------------------------------------------- -- ------------ --- -- ---- --------------------------------------- -- --------- ----------------------------- -- -------------- ------------------------------------------------- -- -------------- -------------------------------------------------------------- -- ---------- ------------------------------------------------------- -- ------------ -------------------------------------------------------------- -- ------------------ ----------------------------------------------------- -- ------------------ -------------------------------------------- -- ---------- --------------------------------------------- -- ----------- -------------------------------------------------------- -- -------------------- ------------------------------------------------------- -- ----- ------- -- ----------- ------ -- ----- ---- --------- -- -------- --------- -- ----- ----------------------------- -- --------- ---- ----------- -- ------ ----- -- --------- ----- -- ---- ----- -- ----------------- ----- -- ------------- -- -- ------------- -- -- ---------- ----- -- ---------- -- -- ----------- ----------------------- -- ----------- ---------------------- -- - ---展开代码
深度讲解
ghUsername(url: string): Promise<string>
ghUsername 函数接受一个 URL 字符串作为参数，返回一个 Promise，Promise 的结果是字符串类型的 GitHub 用户名。使用示例：
ghUsername('https://github.com/octocat').then(username => { console.log(username); // 'octocat' });
ghUsername 的内部实现主要依赖于 got 这个库，它通过发送 GET 请求到 GitHub API 来获取用户信息。具体的实现可以查看 github-username 包的源代码。
ghAvatar(username: string): Promise<string>
ghAvatar 函数接受一个字符串类型的 GitHub 用户名作为参数，返回一个 Promise，Promise 的结果是字符串类型的用户头像地址。使用示例：
ghAvatar('octocat').then(avatar => { console.log(avatar); // 'https://avatars.githubusercontent.com/u/583231?v=4' });
ghAvatar 函数的内部实现也是通过发送 GET 请求到 GitHub API 来获取用户信息。
ghUser(username: string): Promise<object>
ghUser 函数接受一个字符串类型的 GitHub 用户名作为参数，返回一个 Promise
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/47468
