bdd-use-countdown/dist/index.d.ts

React hook encapsulating countdown functionality

import { DateX } from 'bdd-date-ext';

type CountdownValues = {
    days: number;
    hours: number;
    minutes: number;
    seconds: number;
    milliseconds: number;
};
type TimedAction = {
    timestamp: DateX;
    action: (timestamp: DateX) => void;
};
type CountdownArgs = {
    start?: DateX;
    end: DateX;
    onStart?: (start: DateX) => void;
    onEnd?: (end: DateX) => void;
    timedActions?: TimedAction[];
};
declare function useCountdown({ start, end, onStart, onEnd, timedActions, }: CountdownArgs): CountdownValues;

export { useCountdown };