use-countdown

About

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

Installation

npm install --save @rooks/use-countdown

Importing the hook

import useCountdown from "@rooks/use-countdown"

Usage

const endTime = new Date(Date.now() + 10000);

function Demo() {

const count = useCountdown(endTime, {

interval: 1000,

onDown: time => console.log('onDown', time),

onEnd: time => console.log('onEnd', time),

});

return count;

}

render(<Demo/>)

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 Bhargav's discord server

You can click on the floating discord icon at the bottom right of the screen and talk to us in our server.