简体中文

useThrottledFn

Tags:

Utilities

一个帮助创建节流函数的 React Hook。

演示

源码

Count:

wait:

1000

用法

请查看 API。

源码

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

🪝 Hook 🎨 Demo 📄 Document

API

const throttledFn = useThrottledFn(fn, { wait: 1000 })

目标函数 Fn

要节流的函数。

选项 Options

export type ThrottleOptions = {
  /**
   * 节流的时间间隔，单位为毫秒
   *
   * @defaultValue 默认值为 0
   */
  wait?: number
  /**
   * 是否在每个时间间隔的开始调用该函数
   *
   * @defaultValue 默认值为 true
   */
  leading?: boolean
  /**
   * 是否在每个时间间隔的结束调用该函数
   *
   * @defaultValue 默认值为 true
   */
  trailing?: boolean
}

export interface UseThrottledFnOptions extends ThrottleOptions {}

返回值

返回节流后的函数，类型与输入的函数相同。

ON THIS PAGE

#useThrottledFn

#演示

#用法

#源码

#API

#目标函数 Fn

#选项 Options

#返回值

useThrottledFn

演示

用法

源码

API

目标函数 Fn

选项 Options

返回值