useCountdown

Utility

A React hook that creates a countdown timer to a target date with automatic updates and real-time countdown values.

Installation

npm install @thibault.sh/hooks


function useCountdown(
  countDownDate: number, 
  refreshRate?: number
): readonly [number, number, number, number]

Name	Type	Description	Default
`countDownDate`	number	Target date as a timestamp in milliseconds (e.g., new Date('2024-12-31').getTime()).	-
`refreshRate` optional	number	Update interval in milliseconds.	`1000`

readonly [number, number, number, number]

A readonly tuple containing [days, hours, minutes, seconds] representing time remaining.

Property	Type	Description
`[0] days`	number	Number of days remaining (0 if countdown has ended).
`[1] hours`	number	Number of hours remaining (0-23, or 0 if countdown has ended).
`[2] minutes`	number	Number of minutes remaining (0-59, or 0 if countdown has ended).
`[3] seconds`	number	Number of seconds remaining (0-59, or 0 if countdown has ended).