signoz/frontend/src/hooks/useDebouncedFunction.ts

import debounce from 'lodash-es/debounce';
import { useMemo, useRef } from 'react';

export interface DebouncedFunc<T extends (...args: unknown[]) => unknown> {
	(...args: Parameters<T>): ReturnType<T> | undefined;

	cancel(): void;

	flush(): ReturnType<T> | undefined;
}

export type DebounceOptions = {
	leading?: boolean;
	maxWait?: number;
	trailing?: boolean;
};

const defaultOptions: DebounceOptions = {
	leading: false,
	trailing: true,
};

const useDebouncedFn = <T extends (...args: Array<unknown>) => unknown>(
	fn: T,
	wait = 100,
	options: DebounceOptions = defaultOptions,
): DebouncedFunc<T> => {
	const fnRef = useRef(fn);
	fnRef.current = fn;

	return useMemo(
		() => debounce(((...args) => fnRef.current(...args)) as T, wait, options),
		[options, wait],
	);
};

export default useDebouncedFn;