Function > throttle

[PunitSoniME]

throttle(func, [wait=0], [options={}])

Arguments

• func (Function): The function to throttle.
• [wait=0] (number): The number of milliseconds to throttle invocations to.
• [options={}] (Object): The options object.
• [options.leading=true] (boolean): Specify invoking on the leading edge of the timeout.
• [options.trailing=true] (boolean): Specify invoking on the trailing edge of the timeout.

Returns

• (Function): Returns the new throttled function.

Example

// Avoid excessively updating the position while scrolling.
jQuery(window).on('scroll', throttle(updatePosition, 100));
 
// Invoke `renewToken` when the click event is fired, but not more than once every 5 minutes.
var throttled = throttle(renewToken, 300000, { 'trailing': false });
jQuery(element).on('click', throttled);
 
// Cancel the trailing throttled invocation.
jQuery(window).on('popstate', throttled.cancel);