import type { DebouncedFunc, ThrottleSettings } from 'lodash'; /** * Wraps a given callback in a cancelable, throttled function. The throttled * callback is stable and will never change. It will be automatically cancelled * on unmount, unless the `flushOnUnmount` option is passed in, then it will be flushed on unmount. * At the time the throttled function is called, it will call the latest callback that has been passed in. * @param callback callback function to call with throttling * @param throttleMs throttle milliseconds * @param initialOptions lodash throttle options. Will not react to changes to this param * @returns a cancelable, throttled function */ export declare function useThrottledCallback(callback: (...args: TArgs) => TResult, throttleMs: number, initialOptions?: ThrottleSettings & { flushOnUnmount?: boolean; }): DebouncedFunc<(...args: TArgs) => TResult>; export default useThrottledCallback; //# sourceMappingURL=useThrottledCallback.d.ts.map