npm.io
0.0.1 • Published 3 years ago

@cjsoto/streak-counter

Licence
MIT
Version
0.0.1
Deps
0
Size
27 kB
Vulns
0
Weekly
0

@csoto09/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 @csoto09/streak-counter

or

npm install @csoto09/streak-counter

Usage

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

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