介绍
user-contribution 是一个 npm 包,它提供了获取 github 用户贡献数据的方法。
通过 user-contribution,我们可以获取 github 用户的活跃度,包括提交的次数、新增的代码行数、删除的代码行数等。
user-contribution 的使用还可以帮助我们对 github 用户的活跃度进行分析和评估。
安装
使用 npm 安装 user-contribution:
npm install user-contribution
使用方法
引入
在代码中引入 user-contribution:
const getUserContribution = require('user-contribution');
获取数据
使用 getUserContribution 方法获取 github 用户贡献数据:
getUserContribution('username', { count: 7 }).then((data) => console.log(data));
其中,'username' 是需要获取数据的 github 用户名,{ count: 7 } 表示获取过去 7 天的数据。
结果会返回一个对象,包括该用户过去若干天的贡献数据。
-- -------------------- ---- ------- - -------------- - - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - - -- ------------------- - ------ -- ---------- -- ---------- - - -
示例
接下来,让我们通过一个示例来演示 user-contribution 的使用。
引入
首先,在代码中引入 user-contribution:
const getUserContribution = require('user-contribution');
获取数据
我们以 SteveJobsCN 的 github 数据为例,获取过去 30 天的贡献数据:
const username = 'SteveJobsCN'; const count = 30; getUserContribution(username, { count }).then((data) => { console.log(data); });
结果输出
我们可以在控制台上得到如下输出:
-- -------------------- ---- ------- - -------------- - - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ -- -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - -- - ----- ------------- ------ - - -- ------------------- - ------ --- ---------- ---- ---------- -- - -
可以看到,SteveJobsCN 过去 30 天的 github 贡献数据在其中。
结语
本文介绍了 npm 包 user-contribution 的使用方法,并以示例详细阐述了如何使用该包获取 github 用户的贡献数据。
随着 github 的日趋流行,user-contribution 的使用必将越来越广泛。希望本文能对想要使用 user-contribution 的人有所帮助!
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055fec81e8991b448ddaed