Skip to content
On this page

useDebounceFn

取消执行函数。

Debounce是一个超负荷的服务员:如果你一直问他,你的请求将被忽略,直到你停下来,给他一些时间思考你最近的询问。

用法

js
import { useDebounceFn } from '@mpxjs/mpxuse-core'

const debouncedFn = useDebounceFn(() => {
  // do something
}, 1000)

const onScrolling = () => debouncedFn()
import { useDebounceFn } from '@mpxjs/mpxuse-core'

const debouncedFn = useDebounceFn(() => {
  // do something
}, 1000)

const onScrolling = () => debouncedFn()

您还可以向其传递第三个参数,该参数具有最大等待时间,类似于 lodash debounce

js
import { useDebounceFn } from '@mpxjs/mpxuse-core'

// If no invokation after 5000ms due to repeated input,
// the function will be called anyway.
const debouncedFn = useDebounceFn(() => {
  // do something
}, 1000, { maxWait: 5000 })

const onScrolling = () => debouncedFn()
import { useDebounceFn } from '@mpxjs/mpxuse-core'

// If no invokation after 5000ms due to repeated input,
// the function will be called anyway.
const debouncedFn = useDebounceFn(() => {
  // do something
}, 1000, { maxWait: 5000 })

const onScrolling = () => debouncedFn()

推荐阅读

类型声明

typescript
/**
 * Debounce execution of a function.
 *
 * @see https://mpxuse.cn/useDebounceFn
 * @param  fn          A function to be executed after delay milliseconds debounced.
 * @param  ms          A zero-or-greater delay in milliseconds. For event callbacks, values around 100 or 250 (or even higher) are most useful.
 * @param  opts        options
 *
 * @return A new, debounce, function.
 */
export declare function useDebounceFn<T extends FunctionArgs>(
  fn: T,
  ms?: MaybeComputedRef<number>,
  options?: DebounceFilterOptions
): T
/**
 * Debounce execution of a function.
 *
 * @see https://mpxuse.cn/useDebounceFn
 * @param  fn          A function to be executed after delay milliseconds debounced.
 * @param  ms          A zero-or-greater delay in milliseconds. For event callbacks, values around 100 or 250 (or even higher) are most useful.
 * @param  opts        options
 *
 * @return A new, debounce, function.
 */
export declare function useDebounceFn<T extends FunctionArgs>(
  fn: T,
  ms?: MaybeComputedRef<number>,
  options?: DebounceFilterOptions
): T

源码

源码文档

贡献者

pagnkelly

更新日志

No recent changes

根据MIT许可证发布。