Skip to content

Open-source manufacturing ERP, MES and QMS. Quoting, MRP, inventory, shop floor, quality and lot/serial traceability on one Postgres schema, with a REST API and MCP server. Self-host or use Carbon Cloud.

1.4 KB
Raw Blame
// SPDX-License-Identifier: AGPL-3.0-only
// Carbon (github.com/crbnos/carbon). Modified or adapted versions of this file,
// including ports, remain AGPLv3; serving them over a network requires releasing their source.

import { useEffect, useRef } from "react";

/**
 * A function that you call with a throttle delay, the function will be called at most once per delay
 *
 * @param fn The function to throttle
 * @param delay In ms
 * @param executeOnUnmount Whether to execute the pending function when component unmounts
 */
export default function useThrottle<T extends (...args: any[]) => any>(
  fn: T,
  delay: number,
  executeOnUnmount: boolean = false
) {
  const timeout = useRef<ReturnType<typeof setTimeout>>();
  const lastArgs = useRef<Parameters<T>>();

  // biome-ignore lint/correctness/useExhaustiveDependencies: suppressed due to migration
  useEffect(() => {
    return () => {
      if (executeOnUnmount && timeout.current && lastArgs.current) {
        clearTimeout(timeout.current);
        fn(...lastArgs.current);
      } else if (timeout.current) {
        clearTimeout(timeout.current);
      }
    };
  }, [executeOnUnmount]);

  return (...args: Parameters<T>) => {
    lastArgs.current = args;

    if (timeout.current) {
      return;
    }

    timeout.current = setTimeout(() => {
      if (lastArgs.current) {
        fn(...lastArgs.current);
      }
      timeout.current = undefined;
    }, delay);
  };
}