README.md

Welcome to The Streaks 🎉

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

Here is a React App that utilizes the package in order to count your streak.

Install

yarn add @petercr/streak-counter-ts

npm install @petercr/streak-counter-ts

Usage

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

const today = new Date();

const streak = streakCounter(localStorage, today);

// streak returns an object:
// {
//    currentCount: 1,
//    lastLoginDate: "11/11/2021",
//    startDate: "11/11/2021",
// }