SSE Hooks

useCountdown

Custom hook that manages countdown.

Installation

npx sse-tool add use-countdown

Usage

import { useCountdown } from "./{hooks file}";

const [counter, { start, stop, reset }] = useCountdown({
  countStart: 10,
  intervalMs: 1000,
  isIncrement: false,
});

API

Parameters

NameTypeDescription
countdownOptionsCountdownOptionsThe countdown's options.

Return Value

Returns any.

An array containing the countdown's count and its controllers.

Changelog

c165d — feat: enhance useRoleGuard and useSSR hooks with additional options and documentation

30da4 — feat: add new hooks and their metadata

cf13e — feat: add custom hooks for step navigation, ternary dark mode, timeout, toggle, unmount, and window size

Built with Love • © 2026