useThrottleFn
A hook that deal with the throttled function.
Examples
Default usage
Clicked count:0
Default usage
Frequent calls run, but the function is only executed every 500ms.
API
const { run, cancel, flush} = useThrottleFn( fn: (...args: any[]) => any, options?: Options);
const { run, cancel, flush} = useThrottleFn( fn: (...args: any[]) => any, options?: Options);
Params
| Property | Description | Type | Default |
|---|---|---|---|
| fn | The function to throttle. | (...args: any[]) => any | - |
| options | Config for the throttle behaviors | Options | - |
Options
| Property | Description | Type | Default |
|---|---|---|---|
| wait | The number of milliseconds to delay. | number | 1000 |
| noLeading | Specify not invoking on the leading edge of the timeout. | boolean | true |
| noTrailing | Specify not invoking on the trailing edge of the timeout. | boolean | true |
Result
| Property | Description | Type |
|---|---|---|
| run | Invoke and pass parameters to fn. | (...args: any[]) => any |
| cancel | Cancel the invocation of currently throttled function. | () => void |
| flush | Immediately invoke currently throttled function | () => void |