Skip to content

Commit

Permalink
docs: adds default values to useThrottleFn notation (#3927)
Browse files Browse the repository at this point in the history
  • Loading branch information
luckylooke committed May 27, 2024
1 parent a706441 commit 5ab61e7
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions packages/shared/useThrottleFn/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@ import { createFilterWrapper, throttleFilter } from '../utils'
* @param fn A function to be executed after delay milliseconds. The `this` context and all arguments are passed through, as-is,
* to `callback` when the throttled-function is executed.
* @param ms A zero-or-greater delay in milliseconds. For event callbacks, values around 100 or 250 (or even higher) are most useful.
* (default value: 200)
*
* @param [trailing] if true, call fn again after the time is up
* @param [trailing] if true, call fn again after the time is up (default value: false)
*
* @param [leading] if true, call fn on the leading edge of the ms timeout
* @param [leading] if true, call fn on the leading edge of the ms timeout (default value: true)
*
* @param [rejectOnCancel] if true, reject the last call if it's been cancel
* @param [rejectOnCancel] if true, reject the last call if it's been cancel (default value: false)
*
* @return A new, throttled, function.
*/
Expand Down

0 comments on commit 5ab61e7

Please sign in to comment.