Function throttle

throttle<F>(func, wait, options?): ((...args) => ReturnType<F>)
Creates a throttled function that only invokes func at most once per every wait milliseconds (or once per browser frame). 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 throttled function. Subsequent calls to the throttled 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 throttled 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 throttle
- wait: number
  
  The number of milliseconds to throttle invocations to
- Optional options: {
  leading?: boolean;
  trailing?: boolean;
  } = {}
  The options object
  - Optional leading?: boolean
    
    Specify invoking on the leading edge of the timeout
  - Optional trailing?: boolean
    
    Specify invoking on the trailing edge of the timeout
Returns ((...args) => ReturnType<F>)

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

Generated using TypeDoc