@rbxts/pretty-react-hooks/out/use-debounce-callback/use-debounce-callback.d.ts

Useful hooks for @rbxts/react

import { DebounceOptions, Debounced } from "@rbxts/set-timeout";
export interface UseDebounceOptions extends DebounceOptions {
    /**
     * The amount of time to wait before the first call.
     */
    wait?: number;
}
export interface UseDebounceResult<T extends Callback> {
    /**
     * The debounced function.
     */
    run: Debounced<T>;
    /**
     * Cancels delayed invocations to the callback.
     */
    cancel: () => void;
    /**
     * Immediately invokes delayed callback invocations.
     */
    flush: () => void;
    /**
     * Returns whether any invocations are pending.
     */
    pending: () => boolean;
}
/**
 * Creates a debounced function that delays invoking `callback` until after `wait`
 * seconds have elapsed since the last time the debounced function was invoked.
 * The `callback` is invoked with the last arguments provided to the debounced
 * function. Subsequent calls to the debounced function return the result of
 * the last `callback` invocation.
 *
 * See [David Corbacho's article](https://css-tricks.com/debouncing-throttling-explained-examples/)
 * for details over the differences between `debounce` and `throttle`.
 *
 * @param callback The function to debounce.
 * @param options The options object.
 * @returns The new debounced function.
 */
export declare function useDebounceCallback<T extends Callback>(callback: T, options?: UseDebounceOptions): UseDebounceResult<T>;