useThrottle
A hook that deal with the throttled value.
Code demonstration
API
const throttledValue = useThrottle(
value: any,
options?: Options
);
const throttledValue = useThrottle(
value: any,
options?: Options
);
Params
| Property | Description | Type | Default |
|---|---|---|---|
| value | The value to throttle. | Ref<any> | - |
| options | Config for the throttle behaviors. | Options | - |
Options
| Property | Description | Type | Default |
|---|---|---|---|
| wait | The number of milliseconds to delay. | number | 1000 |
| leading | Specify invoking on the leading edge of the timeout. | boolean | true |
| trailing | Specify invoking on the trailing edge of the timeout. | boolean | true |