Skip to content

marekzelinka/streak-counter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@marekzelinka17/streak-counter - a basic streak counter

npm

This is a basic streak counter - inspired by Duolingo - written in TypeScript and meant for the browser (uses localStorage).

This module is available in three formats:

  • ES Module: dist/index.module.js
  • CommonJS: dist/index.cjs
  • UMD: dist/index.umd.js

Install

npm install @marekzelinka17/streak-counter

Usage

Demo

import { streakCounter } from "@marekzelinka17/streak-counter";

const today = new Date();
const streak = streakCounter(localStorage, today);
// streakCounter returns an object:
// {
//    currentCount: 1,
//    lastLoginDate: "11/11/2021",
//    startDate: "11/11/2021",
// }

Credits

License

MIT © Marek Zelinka