mini-timer

mini-timer

The tiniest timer to tick!

mini-timer is a tiny (570 bytes gzipped) event driven timer without any dependencies that quickly and comfortably counts time for you.

    pnpm i mini-timer

Goal

The goal of this package is to provide the smallest possible timer package that is easy to use and as versatile as possible.

Usage

The timer requires 2 (optional 3) arguments that define the start and end point with the increment between steps. The increment also defines how long each time iteration is per update. The sign of the increment defines whether the timer counts up (+) or down (-).

import timer, { type Timer } from 'mini-timer'

// Standard timer: From 0, count ever 1000ms (1s) indefinitely
const t = timer(0, 1000)

// Standard countdown: From 10s count every second to 0
const t = timer(10_000, -1000, 0)

// From 0, count every 100ms until 10,000ms
const t = timer(0, 100, 10000)

Events

The timer has multiple lifecycle events that can be listened on:

import timer, { type Timer, formatTime } from 'mini-timer'

const t = timer(10_000, -150, 0)

t.on('update', (elapsed) => formatTime(time)) // formats the time on each tick to a format of xx:xx or xx:xx:xx
t.on('start', () => console.log("Hello"))
t.on('pause', () => console.log("Pause"))
t.on('finish', (elapsed) => console.log("Preemptively finished at", elapsed))

t.start()
// <code>
t.pause()
// <code>
t.resume()

// The timer will stop when it reaches to (0), but we can stop it preemptively
t.stop() // The default event of stop is "finish".

// Now, clean everything up with "off"
t.off('update', ...) // Removes callback by reference
t.off('update') // Removes all callbacks

© Torathion 2026