Skip to content

useDebounceFn

防抖函数,延迟执行,重复触发时重新计时。


函数签名

ts
function useDebounceFn<T extends FunctionArgs>(
  fn: T,
  ms?: MaybeRefOrGetter<number>,
  options?: DebounceFilterOptions,
): PromisifyFn<T>

基础用法

参数

参数说明类型默认值
fn需要防抖的函数T extends FunctionArgs
ms延迟时间(毫秒)MaybeRefOrGetter<number>200
options配置项DebounceFilterOptions{}

DebounceFilterOptions

参数说明类型默认值
maxWait最大等待时间,超过后强制执行number

返回值

返回一个防抖包装后的函数 PromisifyFn<T>,调用方式与原函数一致。123

代码示例

ts
import { useDebounceFn } from 'ljf-hooks'

const debouncedFn = useDebounceFn(() => {
  // 防抖逻辑
}, 1000, { maxWait: 5000 })

debouncedFn() // 调用防抖函数