@empathyco/x-components
Version:
Empathy X Components
13 lines • 716 B
TypeScript
import type { DebounceOptions } from '../utils/types';
/**
* Composable which wraps the function passed as parameter into a debounced function and returns it.
* It also cancels the debounced function when component is unmounted.
*
* @param fn - Function to be debounced.
* @param debounceTimeInMs - Time of debounce in ms.
* @param debounceOptions - The options for the debounce strategy.
* @returns Debounced function obtained from `fn` parameter.
* @public
*/
export declare function useDebounce<Params extends any[]>(fn: (...args: Params) => void, debounceTimeInMs: number, debounceOptions?: DebounceOptions): import("../utils/types").DebouncedFunction<Params>;
//# sourceMappingURL=use-debounce.d.ts.map