monday-ui-react-core/src/hooks/useTimeout.js

Official monday.com UI resources for application development in React.js

import { useEffect, useRef, useCallback } from "react";
import NOOP from "lodash/noop";

export default function useTimeout({ time = 0, callback, ignoreZeroTime = false }) {
  const ignoreTimeout = time === 0 && ignoreZeroTime;
  const timeoutId = useRef(null);
  const cancelTimeout = useCallback(() => {
    if (!timeoutId.current) {
      return;
    }
    clearTimeout(timeoutId.current);
  }, [timeoutId]);
  useEffect(() => {
    if (ignoreTimeout) {
      return () => {};
    }

    timeoutId.current = setTimeout(callback, time);
    return () => {
      clearTimeout(timeoutId.current);
    };
  }, [callback, time, timeoutId, ignoreTimeout]);

  if (ignoreTimeout) {
    return [NOOP];
  }
  return [cancelTimeout];
}