All files / function/src debounce.ts

100% Statements 7/7
100% Branches 1/1
100% Functions 4/4
100% Lines 6/6

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42                                                      3x         8x     3x 7x 7x 7x      
import { Callback, CancelCallback } from "./_types";
 
/**
 *
 * @example
 * Debounce a Function
 * ```ts
 * const callback = (arg) => console.log(arg);
 *
 * const debouncedCallback = debounce(callback);
 *
 * debouncedCallback(100, 1);
 * // wait 50ms
 *
 * debouncedCallback(100, 2);
 * // wait 100ms
 *
 * // callback is called with arg = 2
 * ```
 *
 * @param callback
 * @returns
 */
type Debounce = <TArgs extends unknown[] = []>(
  callback: Callback<TArgs>
) => (ms: number, ...args: TArgs) => CancelCallback;
 
export const debounce: Debounce = (
  callback,
  // internal variables:
  timeout?: NodeJS.Timeout,
  cancel = () => {
    clearTimeout(timeout);
  }
) => {
  return (ms, ...args) => {
    cancel();
    timeout = setTimeout(callback, ms, ...args);
    return cancel;
  };
};