useThrottleFn

分类

实用工具

导出大小

471 B

上次更改

3 个月前

演示

源代码演练场（测试版）

此演示的延迟设置为 1000 毫秒。

按钮点击次数：0

事件处理程序调用次数：0

用法

import { useThrottleFn
 } from '@vueuse/core'

const throttledFn
 = useThrottleFn
(() => {
  // do something, it will be called at most 1 time per second
}, 1000)

useEventListener(window
, 'resize', throttledFn
)

类型声明

显示类型声明

/**
 * Throttle execution of a function. Especially useful for rate limiting
 * execution of handlers on events like resize and scroll.
 *
 * @param   fn             A function to be executed after delay milliseconds. The `this` context and all arguments are passed through, as-is,
 *                                    to `callback` when the throttled-function is executed.
 * @param   ms             A zero-or-greater delay in milliseconds. For event callbacks, values around 100 or 250 (or even higher) are most useful.
 *                                    (default value: 200)
 *
 * @param [trailing] if true, call fn again after the time is up (default value: false)
 *
 * @param [leading] if true, call fn on the leading edge of the ms timeout (default value: true)
 *
 * @param [rejectOnCancel] if true, reject the last call if it's been cancel (default value: false)
 *
 * @return  A new, throttled, function.
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare function useThrottleFn
<T
 extends FunctionArgs
>(
  fn
: T
,
  ms
?: MaybeRefOrGetter
<number>,
  trailing
?: boolean,
  leading
?: boolean,
  rejectOnCancel
?: boolean,
): PromisifyFn
<T
>