debounce
最后更新于：2022-04-02 00:00:58
## debounce
+ [link](./debounce "Link to this entry.")
+ [source](https://github.com/lodash/lodash/blob/4.5.0正式版/lodash.src.js#L8616 "View in source.")
+ [npm](https://www.npmjs.com/package/lodash.debounce "See the npm package.")
```
_.debounce(func, [wait=0], [options])
```
创建一个防抖动函数。 该函数会在 `wait` 毫秒后调用 `func` 方法。 该函数提供一个 `cancel` 方法取消延迟的函数调用以及 `flush` 方法立即调用。 可以提供一个 `options` 对象决定如何调用 `func` 方法， options.leading 与|或 options.trailing 决定延迟前后如何触发。 `func` 会传入最后一次传入的参数给防抖动函数。 随后调用的防抖动函数返回是最后一次 `func` 调用的结果。
**注意:** 如果 `leading` 和 `trailing` 都设定为 true。 则 func 允许 trailing 方式调用的条件为: 在 wait 期间多次调用防抖方法。
查看 [David Corbacho's article](http://drupalmotion.com/article/debounce-and-throttle-visual-explanation) 了解 `_.debounce` 与 `_.throttle` 的区别。
### 参数
1. func (Function)
要防抖动的函数
2. [wait=0] (number)
需要延迟的毫秒数
3. [options] (Object)
选项对象
4. [options.leading=false] (boolean)
指定调用在延迟开始前
5. [options.maxWait] (number)
设置 `func` 允许被延迟的最大值
6. [options.trailing=true] (boolean)
指定调用在延迟结束后
### 返回值 (Function)
返回具有防抖动功能的函数
### 示例
```
// 避免窗口在变动时出现昂贵的计算开销。
jQuery(window).on('resize', _.debounce(calculateLayout, 150));
// 当点击时 `sendMail` 随后就被调用。
jQuery(element).on('click', _.debounce(sendMail, 300, {
'leading': true,
'trailing': false
}));
// 确保 `batchLog` 调用1次之后，1秒内会被触发。
var debounced = _.debounce(batchLog, 250, { 'maxWait': 1000 });
var source = new EventSource('/stream');
jQuery(source).on('message', debounced);
// 取消一个 trailing 的防抖动调用
jQuery(window).on('popstate', debounced.cancel);
```
';