Mirrors/lodash
1
0
Fork 0
mirror of https://github.com/whoisclebs/lodash.git synced 2026-02-06 09:47:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add doc note to debounce and throttle about the arguments provided to the invoked func. [ci skip]

Browse Source
This commit is contained in:
John-David Dalton
2015-11-17 13:31:02 -08:00
parent ecef32a101
commit dcca9b82b1
1 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
lodash.js
View File

@@ -8245,9 +8245,10 @@
* milliseconds have elapsed since the last time the debounced function was * milliseconds have elapsed since the last time the debounced function was
* invoked. The debounced function comes with a `cancel` method to cancel * invoked. The debounced function comes with a `cancel` method to cancel
* delayed `func` invocations and a `flush` method to immediately invoke them. * delayed `func` invocations and a `flush` method to immediately invoke them.
* Provide an options object to indicate that `func` should be invoked on the * Provide an options object to indicate whether `func` should be invoked on
* leading and/or trailing edge of the `wait` timeout. Subsequent calls to the * the leading and/or trailing edge of the `wait` timeout. The `func` is invoked
* debounced function return the result of the last `func` invocation. * with the last arguments provided to the debounced function. Subsequent calls
* to the debounced function return the result of the last `func` invocation.
* *
* **Note:** If `leading` and `trailing` options are `true`, `func` is invoked * **Note:** If `leading` and `trailing` options are `true`, `func` is invoked
* on the trailing edge of the timeout only if the the debounced function is * on the trailing edge of the timeout only if the the debounced function is
@@ -8856,9 +8857,11 @@
/** /**
* Creates a throttled function that only invokes `func` at most once per * Creates a throttled function that only invokes `func` at most once per
* every `wait` milliseconds. The throttled function comes with a `cancel` * every `wait` milliseconds. The throttled function comes with a `cancel`
* method to cancel delayed invocations. Provide an options object to indicate * method to cancel delayed `func` invocations and a `flush` method to
* that `func` should be invoked on the leading and/or trailing edge of the * immediately invoke them. Provide an options object to indicate whether
* `wait` timeout. Subsequent calls to the throttled function return the * `func` should be invoked on the leading and/or trailing edge of the `wait`
* timeout. The `func` is invoked with the last arguments provided to the
* throttled function. Subsequent calls to the throttled function return the
* result of the last `func` call. * result of the last `func` call.
* *
* **Note:** If `leading` and `trailing` options are `true`, `func` is invoked * **Note:** If `leading` and `trailing` options are `true`, `func` is invoked