use-streak
use-streak copied to clipboard
a streak counter to track your streak in days (similar to Duolingo)
useStreak - 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 use-streak
npm install use-streak
Usage
import { useStreak } from "use-streak";
const today = new Date();
const streak = useStreak(localStorage, today);
// streak returns an object:
// {
// currentCount: 1,
// lastLoginDate: "11/11/2021",
// startDate: "11/11/2021",
// }
LICENSE
MIT. Just make sure you give acknowledgements to this repo.