All files / function/src throttle.ts

100% Statements 11/11
100% Branches 1/1
100% Functions 5/5
100% Lines 10/10

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 43 44 45 46 47                                              3x           3x 1x     3x 6x   6x 4x 3x 3x       6x      
import { Callback, CancelCallback } from "./_types";
 
/**
 *
 * @example
 * Throttle a Function
 * ```ts
 * const callback = (arg) => console.log(arg);
 *
 * const throttledCallback = throttle(callback);
 *
 * throttledCallback(100, 1);
 * // wait 50ms
 *
 * throttledCallback(100, 2);
 * // wait 50ms
 *
 * // callback is called with arg = 2
 * ```
 *
 * @param callback
 * @returns
 */
export const throttle = <TArgs extends unknown[] = []>(
  callback: Callback<TArgs>
): ((ms: number, ...args: TArgs) => CancelCallback) => {
  let timeout: NodeJS.Timeout | undefined;
  let lastArgs: TArgs;
 
  const cancel = () => {
    clearTimeout(timeout);
  };
 
  return (ms, ...args) => {
    lastArgs = args;
 
    if (!timeout) {
      timeout = setTimeout(() => {
        callback(...lastArgs);
        timeout = undefined;
      }, ms);
    }
 
    return cancel;
  };
};