# \_.throttle

**语法：**

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

**源代码链接：**[source](https://github.com/lodash/lodash/blob/4.17.10/lodash.js#L10896)

**npm包链接：**[npm package](https://www.npmjs.com/package/lodash.throttle)

**描述：**

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

> **注意:**
>
> 如果`leading`和`trailing`都设定为`true`则`func`允许 trailing 方式调用的条件为: 在`wait`期间多次调用。
>
> 如果`wait`为`0`并且`leading`为`false`,`func`调用将被推迟到下一个点，类似`setTimeout`为`0`的超时。
>
> 查看[David Corbacho's article](https://css-tricks.com/debouncing-throttling-explained-examples/)了解[`_.throttle`](https://lodash.com/docs/4.17.10#throttle)与[`_.debounce`](https://lodash.com/docs/4.17.10#debounce)的区别。

**开始版本：**0.1.0

**参数：**

* `func (Function)`: 要节流的函数。
* `[wait=0] (number)`: 需要节流的毫秒。
* `[options={}] (Object)`: 选项对象。
* `[options.leading=true] (boolean)`: 指定调用在节流开始前。
* `[options.trailing=true] (boolean)`: 指定调用在节流结束后。

**返回值：**

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

  **例子：**

```javascript
// 避免在滚动时过分的更新定位
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);
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://lodash.shujuwajue.com/function/throttle.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.