Function debounce

debounce<F>(func, wait, options?): ((...args) => ReturnType<F>)
Creates a debounced function that delays invoking func until after wait milliseconds have elapsed since the last time the debounced function was invoked, or until the next browser frame is drawn. Provide options to indicate whether func should be invoked on the leading and/or trailing edge of the wait timeout. The func is invoked with the last arguments provided to the debounced function. Subsequent calls to the debounced function return the result of the last func invocation. Note: If leading and trailing options are true, func is invoked on the trailing edge of the timeout only if the debounced function is invoked more than once during the wait timeout. If wait is 0 and leading is false, func invocation is deferred until the next tick, similar to setTimeout with a timeout of 0.
Type Parameters
- F extends ((...args) => any)
Parameters
- func: F
  The function to debounce
- wait: number
  
  The number of milliseconds to delay
- Optional options: {
      leading?: boolean;
      maxWait?: number;
      trailing?: boolean;
  } = {}
  The options object
  - Optional leading?: boolean
    
    Specify invoking on the leading edge of the timeout
  - Optional maxWait?: number
    
    The maximum time func is allowed to be delayed before it's invoked
  - Optional trailing?: boolean
    
    Specify invoking on the trailing edge of the timeout
Returns ((...args) => ReturnType<F>)

Returns the new debounced function
- - (...args): ReturnType<F>
  - Parameters
    - Rest ...args: Parameters<F>
    Returns ReturnType<F>
- Defined in throttle.ts:26

Generated using TypeDoc