@ozen-ui/kit/__inner__/cjs/hooks/useTimer/useTimer.d.ts

React component library

export type TimerOptions = {
    /** Время старта таймера (миллисекунды) */
    startTime?: number;
    /** Время завершения таймера (миллисекунды) */
    endTime?: number;
    /** Интервал в миллисекундах */
    interval?: number;
    /** Callback-функция вызываемая при завершении времени таймера */
    onTimerEnd?: () => void;
};
export type TimerValues = {
    /** Счетчик отсчета */
    count: number;
    /** Признак запущенного счетчика */
    isTimerRunning: boolean;
    /** Запустить таймер */
    startTimer: () => void;
    /** Остановить таймер */
    pauseTimer: () => void;
    /** Сбросить таймер — сбрасывает count в исходное состояние и останавливает таймер */
    resetTimer: () => void;
};
export declare function useTimer({ startTime, endTime, interval, onTimerEnd, }: TimerOptions): TimerValues;