@mmednik/streak-counter - a basic streak counter

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

Install

yarn add @mmednik/streak-counter

or

npm install @mmednik/streak-counter

Usage

import { streakCounter } from '@mmednik/streak-counter'

const today = new Date()
const streak = streakCounter(localStorage, today)

streak returns an object:

{
  currentCount: 1,
  lastLoginDate: "02/06/2023",
  startDate: "02/06/2023",
}