useDebounceFn

Overview

A hook that deal with the debounced function.

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

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

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

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

A hook that deal with the debounced function.

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

Property	Description	Type	Default
fn	The function to debounce.	`(...args: any[]) => any`	-
options	Config for the debounce 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`	`false`
trailing	Specify invoking on the trailing edge of the timeout.	`boolean`	`true`
maxWait	The maximum time func is allowed to be delayed before it’s invoked.	`number`	-

Property	Description	Type
run	invoke and pass parameters to fn.	`(...args: any[]) => any`
cancel	Cancel the invocation of currently debounced function.	`() => void`
flush	Immediately invoke currently debounced function.	`() => void`