useCountdown

About

Count down to a target timestamp and call callbacks every second (or provided peried)

Examples

Basic example

const endTime = new Date(Date.now() + 10000);
import { useCountdown } from "rooks";
export default function App() {
  const count = useCountdown(endTime, {
    interval: 1000,
    onDown: time => console.log("onDown", time),
    onEnd: time => console.log("onEnd", time),
  });
  return count;
}

Open Sandbox

Arguments

Argument	Type	Description	Default value
endTime	Date	the time when the countdown should end	undefined
options.interval	number	milliseconds that it takes count down once	1000
options.onDown	function	(time) => , callback that would be called every interval	undefined
options.onEnd	function	(time) => , callback that would be called when the countdown ends	undefined

Return Value

Type	Description
number	rest amount of intervals it takes to count down to the endTime

Join the community!

Join our discord server! You can click the floating discord icon at the bottom right of the screen and chat with us!

❇️ State

🔥 Effects

⚛️ UI

✨ Misc

🚀 Events

📝 Form