rooks/dist/esm/hooks/useCountdown.js

Essential React custom hooks ⚓ to super charge your components!

import { useState } from "react";
import { useIntervalWhen } from "./useIntervalWhen";
/**
 *
 * useCountdown
 * Easy way to countdown until a given endtime in intervals
 *
 * @param endTime Time to countdown
 * @param options  Countdown options
 * @see https://react-hooks.org/docs/useCountdown
 */
function useCountdown(endTime, options) {
    if (options === void 0) { options = {}; }
    var _a = options.interval, interval = _a === void 0 ? 1000 : _a, onDown = options.onDown, onEnd = options.onEnd;
    var _b = useState(function () { return new Date(); }), time = _b[0], setTime = _b[1];
    var restTime = endTime.getTime() - time.getTime();
    var count = restTime > 0 ? Math.ceil(restTime / interval) : 0;
    useIntervalWhen(onTick, count ? interval : undefined, true, true);
    return count;
    function onTick() {
        var newTime = new Date();
        if (newTime > endTime) {
            if (onEnd) {
                onEnd(newTime);
            }
            setTime(endTime);
            return;
        }
        if (onDown) {
            onDown(restTime, newTime);
        }
        setTime(newTime);
    }
}
export { useCountdown };