mirror of
https://github.com/whoisclebs/lodash.git
synced 2026-02-07 18:07:49 +00:00
Clarify _.debounce and _.throttle docs. [ci skip]
This commit is contained in:
@@ -7752,12 +7752,13 @@
|
|||||||
var curryRight = createCurry(CURRY_RIGHT_FLAG);
|
var curryRight = createCurry(CURRY_RIGHT_FLAG);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a function that delays invoking `func` until after `wait` milliseconds
|
* Creates a debounced function that delays invoking `func` until after `wait`
|
||||||
* have elapsed since the last time it was invoked. The created function comes
|
* milliseconds have elapsed since the last time the debounced function was
|
||||||
* with a `cancel` method to cancel delayed invocations. Provide an options
|
* invoked. The debounced function comes with a `cancel` method to cancel
|
||||||
* object to indicate that `func` should be invoked on the leading and/or
|
* delayed invocations. Provide an options object to indicate that `func`
|
||||||
* trailing edge of the `wait` timeout. Subsequent calls to the debounced
|
* should be invoked on the leading and/or trailing edge of the `wait` timeout.
|
||||||
* function return the result of the last `func` invocation.
|
* 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
|
||||||
@@ -8325,12 +8326,12 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a function that only invokes `func` at most once per every `wait`
|
* Creates a throttled function that only invokes `func` at most once per
|
||||||
* milliseconds. The created function comes with a `cancel` method to cancel
|
* every `wait` milliseconds. The throttled function comes with a `cancel`
|
||||||
* delayed invocations. Provide an options object to indicate that `func`
|
* method to cancel delayed invocations. Provide an options object to indicate
|
||||||
* should be invoked on the leading and/or trailing edge of the `wait` timeout.
|
* that `func` should be invoked on the leading and/or trailing edge of the
|
||||||
* Subsequent calls to the throttled function return the result of the last
|
* `wait` timeout. Subsequent calls to the throttled function return the
|
||||||
* `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
|
||||||
* on the trailing edge of the timeout only if the the throttled function is
|
* on the trailing edge of the timeout only if the the throttled function is
|
||||||
|
|||||||
Reference in New Issue
Block a user