On this page

useDebounceFn

处理防抖函数的 Hook

代码演示

API

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

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

Params

参数	说明	类型	默认值
fn	需要防抖执行的函数	`(...args: any[]) => any`	-
options	配置防抖的行为	`Options`	-

Options

参数	说明	类型	默认值
wait	等待时间，单位为毫秒	`number`	`1000`
leading	是否在延迟开始前调用函数	`boolean`	`false`
trailing	是否在延迟开始后调用函数	`boolean`	`true`
maxWait	最大等待时间，单位为毫秒	`number`	-

Result

参数	说明	类型
run	触发执行 fn，函数参数将会传递给 fn	`(...args: any[]) => any`
cancel	取消当前防抖	`() => void`
flush	立即调用当前防抖函数	`() => void`

Source

源码 • 文档 • 示例