useDebouncedFn

一个创建防抖函数的 React Hook。

演示

源码
Count:
0
wait:
300

用法

请查看 API。

源码

点击下方链接跳转 GitHub 查看源代码。

API

const debouncedFn = useDebouncedFn(fn, options)

目标函数 Fn

要进行防抖的函数。

选项 Options

export type DebounceOptions = {
  /**
   * 调用函数前等待的时间
   *
   * @defaultValue 0
   */
  wait?: number
  /**
   * 在超时前立即调用
   *
   * @defaultValue false
   */
  leading?: boolean
  /**
   * 在超时后调用函数
   *
   * @defaultValue true
   */
  trailing?: boolean
}

export type UseDebouncedFnOptions = DebounceOptions & {}

返回值

与输入函数相同的带有防抖特性的函数。