@marekzelinka/streak-counter

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

Install

If you're using npm:

# for npm:
npm install @marekzelinka/streak-counter

Or, if you're using pnpm:

pnpm add @marekzelinka/streak-counter

Usage

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

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

Credits

• Build a TypeScript Project From Scratch
• How To Create An NPM Package
• Bunchee - bundler for ECMAScript and TypeScript packages