Go to repository
Internal

Interface DebouncedFunction<F>

The type of a function that was debounced.

interface DebouncedFunction<F> {
    clear(): void;
    flush(): void;
    trigger(): void;
    (...arguments_: Parameters<F>): ReturnType<F>;
}

Type Parameters

Parameters

Returns ReturnType<F>

Methods

cancels any scheduled executions.

Returns void

if an execution is scheduled then it will be immediately executed and the timer will be cleared.

Returns void

executes the function immediately and clears the timer if it was previously set.

Returns void