@common-utilities/debounce/src/index.ts

A basic implementation of the common utility function, Debounce 🏓

type Fn = (args?: unknown) => void

/**
 * debounce 🏓
 * ---
 * @description a basic implementation of debounce
 * @param fn a function callback
 * @param delay a number in milliseconds
 * @example debounce(fn, 100);
 */
export const debounce =
  (fn: Fn, delay: number, timeout = 0): Fn =>
  (args?: unknown) => {
    clearTimeout(timeout)
    // adds `as unknown as number` to ensure setTimeout returns a number
    // like window.setTimeout
    timeout = setTimeout((): void => fn(args), delay) as unknown as number
  }