_.throttle

语法:

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

源代码链接:source

npm包链接:npm package

描述:

创建一个节流函数,在 wait 秒内最多执行func一次的函数。 该函数提供一个cancel方法取消延迟的函数调用以及flush方法立即调用。 可以提供一个 options 对象决定如何调用func方法, options.leading 与|或 options.trailing 决定 wait 前后如何触发。func会传入最后一次传入的参数给这个函数。 随后调用的函数返回是最后一次func调用的结果。

注意:

如果leadingtrailing都设定为truefunc允许 trailing 方式调用的条件为: 在wait期间多次调用。

如果wait0并且leadingfalse,func调用将被推迟到下一个点,类似setTimeout0的超时。

查看David Corbacho's article了解_.throttle_.debounce的区别。

开始版本:0.1.0

参数:

  • func (Function): 要节流的函数。

  • [wait=0] (number): 需要节流的毫秒。

  • [options={}] (Object): 选项对象。

  • [options.leading=true] (boolean): 指定调用在节流开始前。

  • [options.trailing=true] (boolean): 指定调用在节流结束后。

返回值:

  • (Function): 返回节流的函数。

    例子:

// 避免在滚动时过分的更新定位
jQuery(window).on('scroll', _.throttle(updatePosition, 100));

// 点击后就调用 `renewToken`,但5分钟内超过1次。
var throttled = _.throttle(renewToken, 300000, { 'trailing': false });
jQuery(element).on('click', throttled);

// 取消一个 trailing 的节流调用。
jQuery(window).on('popstate', throttled.cancel);

Last updated