Function useTimer

packages/shared/src/hooks/useTimer.ts:12–53

(
  callback: CallbackFn<T>,
  initialTimer: number,
)

  clearTimer: () => void;
}
export default function useTimer<T = unknown>(
  callback: CallbackFn<T>,
  initialTimer: number,
): UseTimerReturnProps {
  const initRef = useRef(false);
  const [timer, setTimer] = useState(initialTimer);
  const [runTimer, clearTimer] = useDebounceFn(() => {
    if (timer > 0) {
      setTimer((_timer) => _timer - 1);
      runTimer();
    } else {
      if (callback) {
        callback();
      }
      clearTimer();
    }
  }, 1000);

  // if the initial timer is greater than 0, then we start it on load.
  // we utilized a `ref` to ensure this will only be triggered once
  useEffect(() => {
    if (initRef.current) {
      return;
    }

    initRef.current = true;

    if (initialTimer > 0) {
      runTimer();
    }
  }, [initialTimer, runTimer]);

  return useMemo(
    () => ({
      timer,
      setTimer,
      runTimer,
      clearTimer,
    }),
    [timer, setTimer, runTimer, clearTimer],
  );
}