/streak-counter

a streak counter for the browser, inspired by Duolingo.

Primary LanguageTypeScriptMIT LicenseMIT

@VAggrippino/streak-counter - a basic streak counter

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

Install

yarn add @VAggrippino/streak-counter

– Or –

npm install @VAggrippino/streak-counter

Usage

import {streakCounter} from '@VAggrippino/streak-counter';

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

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