@tempfix/watcher/ts/dettle/throttle.ts

The file system watcher that strives for perfection, with no native dependencies and optional rename detection support.

/* IMPORT */

import debounce from './debounce.js';
import type {FN, Throttled} from './types.js';

/* MAIN */

const throttle = <Args extends unknown[]> ( fn: FN<Args, unknown>, wait: number = 1, options?: { leading?: boolean, trailing?: boolean } ): Throttled<Args> => {

  return debounce ( fn, wait, {
    maxWait: wait,
    leading: options?.leading ?? true,
    trailing: options?.trailing ?? true
  });

};

/* EXPORT */

export default throttle;