npm 包 findstreak 使用教程

简介

findstreak 是一个用于计算 Github 用户代码连续贡献天数的 npm 包。它可以通过 Github API 获取用户的代码提交记录,计算出连续贡献天数,并提供了相应的 API。

安装

--- ------- ---------- ----------

使用

在 Node.js 中使用

导入 findstreak:

----- ---------- - ----------------------

调用 API:

----------------------
    --------- ------------------
    ------ --------------
------------- -- -
    ------------------------
-------------- -- -
    -------------------
---

其中,username 表示 Github 用户名,token 是 Github API 的个人访问令牌。

在浏览器中使用

引入 findstreak.js:

------- -----------------------------

调用 API:

----------------------
    --------- ------------------
    ------ --------------
------------- -- -
    ------------------------
-------------- -- -
    -------------------
---

API

findstreak.getStreak(options)

计算 Github 用户的代码连续贡献天数。

参数:

  • options
    • username(必需):Github 用户名。
    • token(必需):Github API 的个人访问令牌。
    • startDate(可选):开始日期,格式为 YYYY-MM-DD,默认为 1 年之前。
    • endDate(可选):结束日期,格式为 YYYY-MM-DD,默认为今天。

返回值:

-
    --------- ---
    ------------ -------------
    ---------- ------------
-

其中,streak 表示连续贡献天数,startDateendDate 表示计算连续贡献天数的起始日期和结束日期。

示例

在 Node.js 中使用

----- ---------- - ----------------------

----------------------
    --------- ----------
    ------ -------------------
------------- -- -
    ------------------------
-------------- -- -
    -------------------
---

输出:

-

在浏览器中使用

--------- -----
------
------
    ----------------- ---------------
    ------- -----------------------------
    --------
        ----------------------
            --------- ----------
            ------ -------------------
        ------------- -- -
            ------------------------
        -------------- -- -
            -------------------
        ---
    ---------
-------
------
-------
-------

打开

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60055fa181e8991b448dcf67


猜你喜欢

  • npm 包 vue-multiple-button 使用教程

    介绍 vue-multiple-button 是一个 Vue.js 库,用于创建多样式多功能的按钮组件。 它支持以下功能: 支持圆角按钮 支持可选中的按钮 支持不同类型的按钮,例如主按钮、次按钮和警...

    3 年前
  • npm 包 evevnt-listener-options 使用教程

    前言 在前端开发中,我们经常需要监听 DOM 元素的事件,如点击、滚动等等。而事件监听器的默认行为可能并不符合我们的需求。比如,我们需要阻止事件的冒泡传递、停止事件的默认行为等等。

    3 年前
  • npm 包 antool 使用教程

    简介 antool 是一个前端工具库,提供了许多常用的 JavaScript 函数和工具函数,可以帮助开发者提高开发效率和代码质量。使用 npm 安装 antool,可以很方便地在项目中使用它提供的各...

    3 年前
  • npm 包 wxj-cli 使用教程

    前言 在前端开发中,很多时候我们需要使用命令行工具来进行项目构建、打包等操作。而 wxj-cli 是一个 npm 包,它提供了一套易用、高效且可配置的命令行界面,可以大大提高前端开发效率。

    3 年前
  • npm 包 clone-deep2 使用教程

    在前端开发中,有时候需要深度复制一个对象,这时候可以使用 npm 包 clone-deep2 进行操作。本文将详细介绍如何使用该包进行深度复制操作,并提供示例代码供读者参考。

    3 年前
  • npm 包 cloverx-logger 使用教程

    在前端开发中,日志记录是一个非常重要的方面,能够帮助开发者快速定位问题并进行调试。npm 包 cloverx-logger 是一个专门针对前端开发的日志记录库,它可以帮助我们在前端应用中快速记录和输出...

    3 年前
  • npm 包 jddj-generator-vue 使用教程

    在前端开发中,经常会使用一些自动化工具来快速生成项目或者模块的代码文件。其中,jddj-generator-vue 是一个可以快速生成基于 Vue.js 的前端项目骨架的 npm 包。

    3 年前
  • npm 包 postcss-tree-shaking 使用教程

    在前端开发中,我们经常会使用一些 CSS 预处理器和工具来简化和优化 CSS 的编写和管理。其中,在 CSS 的优化中,Tree Shaking 技术可以减少未使用的样式的打包体积,从而优化网站的性能...

    3 年前
  • npm 包 rds-spinner 使用教程

    前言 在前端开发中,经常需要在异步操作时添加一个上传中、加载中的动画效果,为用户提供更好的交互体验。rds-spinner 是一个基于 CSS3 动画的 npm 包,提供了多种不同样式的加载图标,可供...

    3 年前
  • npm 包 gulp-cmdcompile 使用教程

    什么是 npm 包 gulp-cmdcompile? gulp-cmdcompile 是一个基于 Gulp 的前端构建工具,用于将 CMD 规范的 JavaScript 文件编译成浏览器能够运行的 J...

    3 年前
  • npm包ng-app-fw使用教程

    介绍 ng-app-fw是一个提供AngularJS框架的轻量级npm包,它可以为AngularJS应用提供一些常用的、易于使用的UI组件和服务。这篇文章将会介绍如何使用ng-app-fw,你将会学习...

    3 年前
  • npm 包 ababa 使用教程

    npm 是现代前端开发中必不可少的工具之一,它可以让我们方便地安装和管理各种 JavaScript 包。其中,ababa 是一个由 jsperf-abc 项目衍生出来的性能测试项目,它允许我们可以快速...

    3 年前
  • npm 包 walk-object-sync 使用教程

    在前端开发中,经常需要遍历对象或数组,我们一般使用 for 循环或 forEach 方法。但是当对象的嵌套层级比较深时,这种方式会显得非常繁琐。为了解决这个问题,可以使用 npm 包 walk-obj...

    3 年前
  • npm 包 dz-promise 使用教程

    前言 在前端开发中,我们经常需要处理异步请求、跨域请求等问题。这些问题一般都可以通过 Promise 来解决。而 Promise 是 JavaScript 中的一个重要概念,它是异步编程的解决方案之一...

    3 年前
  • npm 包 mrkd 使用教程

    在前端开发中,我们经常使用各种 npm 包来辅助我们的工作。其中,markdown 渲染是很常见的需求。本篇文章将介绍一个 npm 包 mrkd,它可以将 markdown 文本转换为 HTML,支持...

    3 年前
  • npm 包 node-accountkit 使用教程

    介绍 node-accountkit 是一个基于 Node.js 的 npm 包,用于与 Facebook 的 Account Kit 进行通信。Account Kit 是一个用户认证服务,可以允许用...

    3 年前
  • npm 包 @anilanar/workbox-webpack-plugin 使用教程

    前言 现在的 web 应用离不开离线支持,因为网络随时可能中断,而像在线游戏这类实时应用则需要以最大限度减少延迟的方式来提供最佳体验。Web 应用可以利用 Service Worker 实现离线支持和...

    3 年前
  • npm 包 @jsbx/get-params 使用教程

    前言 在前端开发中,我们经常需要从 URL 中获取参数来进行相应的操作,而获取 URL 参数的过程又不是非常直接和方便。@jsbx/get-params 正是针对这个问题而产生的 npm 包,它主要解...

    3 年前
  • npm 包 coastroad 使用教程

    什么是 npm 包 coastroad npm 包 coastroad 是一个基于 swagger-js 和 axios 的 Node.js 模块,用于快速、简单地连接和访问 RESTful API。

    3 年前
  • npm 包 dz-vue-event 使用教程

    简介 在 Vue.js 开发中,事件是一种非常重要的概念。Vue.js 通过自定义事件的方式实现组件之间数据的传递。然而,在某些情况下,Vue.js 自带的事件并不能完全满足我们的需求。

    3 年前

相关推荐

    暂无文章