fn.js

Methods

(static) debounce(func, wait, immediateopt, contextopt) → {function}

Creates a debounced function that delays invoking func until after wait milliseconds have elapsed since the last time the debounced function was invoked.

Inspired by lodash and underscore implementations.

Parameters:
NameTypeAttributesDefaultDescription
funcfunction

The function to wrap with debounce behavior.

waitnumber

The number of milliseconds to wait after the last invocation.

immediateboolean<optional>

Whether or not to invoke the function immediately upon creation.

contextObject<optional>
window

The "context" in which the debounced function should debounce. For example, if this function should be tied to a Video.js player, the player can be passed here. Alternatively, defaults to the global window object.

Returns:

A debounced function.

Type: 
function

(static) throttle(fn, wait) → {function}

Wraps the given function, fn, with a new function that only invokes fn at most once per every wait milliseconds.

Parameters:
NameTypeDescription
fnfunction

The function to be throttled.

waitnumber

The number of milliseconds by which to throttle.

Returns:
Type: 
function