useThrottleFn

Overview

A hook that deal with the throttled function.

pnpm dlx shadcn@latest add https://shadcn-ahooks.vercel.app/r/useThrottleFn.json

npx shadcn@latest add https://shadcn-ahooks.vercel.app/r/useThrottleFn.json

yarn shadcn@latest add https://shadcn-ahooks.vercel.app/r/useThrottleFn.json

bun shadcn@latest add https://shadcn-ahooks.vercel.app/r/useThrottleFn.json

A hook that deal with the throttled function.

const {
  run,
  cancel,
  flush
} = useThrottleFn(
  fn: (...args: any[]) => any,
  options?: Options
);

Property	Description	Type	Default
fn	The function to throttle.	`(...args: any[]) => any`	-
options	Config for the throttle behaviors	`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`

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`