use-lodash-debounce-throttle/src/use-debounce.ts

Bring debounce & throttle of lodash version to react-hooks

import { debounce } from 'lodash-es';
import createCancelableHook from './createCancelableHook';

interface DebounceSettings {
  /**
   * Specify invoking on the leading edge of the timeout.
   */
  leading?: boolean;

  /**
   * The maximum time func is allowed to be delayed before it’s invoked.
   */
  maxWait?: number;

  /**
   * Specify invoking on the trailing edge of the timeout.
   */
  trailing?: boolean;
}

const useDebounce = createCancelableHook((...params) => debounce(...params), (wait?: number, options?: DebounceSettings) => {
  const compareParams: any[] = [wait];
  if (options) {
    compareParams.push(options.leading);
    compareParams.push(options.maxWait);
    compareParams.push(options.trailing);
  }
  return compareParams;
})

export default useDebounce;