watchDebounced

类别

Watch

导出体积

455 B

上次更改

7 minutes ago

别名

debouncedWatch

防抖监听。回调函数仅在源停止变化指定时长后才会被调用。

示例

源码playground (beta)

此演示中延迟设置为 1000ms，最大等待时间设置为 5000ms。

输入内容：

更新次数：0

使用方法

类似于 watch，但提供额外选项 debounce 和 maxWait，它们将应用于回调函数。

import { watchDebounced } from '@vueuse/core'

watchDebounced(
  source,
  () => { console.log('变化了！') },
  { debounce: 500, maxWait: 1000 },
)

选项

选项	类型	默认值	说明
debounce	MaybeRefOrGetter<number>	0	防抖延迟时间（毫秒）（支持响应式）
maxWait	MaybeRefOrGetter<number>	—	最大等待时间，超过后强制调用回调函数

所有标准的 watch 选项（如 deep、immediate、flush 等）均支持。

响应式防抖时间

防抖时间参数可以是响应式的：

import { watchDebounced } from '@vueuse/core'

const debounceMs = ref(500)

watchDebounced(
  source,
  () => { console.log('变化了！') },
  { debounce: debounceMs },
)

// 之后可以修改防抖时间
debounceMs.value = 1000

工作原理

本质上，它是以下代码的简写形式：

import { debounceFilter, watchWithFilter } from '@vueuse/core'

watchWithFilter(
  source,
  () => { console.log('变化了！') },
  {
    eventFilter: debounceFilter(500, { maxWait: 1000 }),
  },
)

类型声明

显示类型声明

export interface WatchDebouncedOptions<Immediate>
  extends WatchOptions<Immediate>, DebounceFilterOptions {
  debounce?: MaybeRefOrGetter<number>
}
export declare function watchDebounced<
  T extends Readonly<MultiWatchSources>,
  Immediate extends Readonly<boolean> = false,
>(
  sources: [...T],
  cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>,
  options?: WatchDebouncedOptions<Immediate>,
): WatchHandle
export declare function watchDebounced<
  T,
  Immediate extends Readonly<boolean> = false,
>(
  source: WatchSource<T>,
  cb: WatchCallback<T, Immediate extends true ? T | undefined : T>,
  options?: WatchDebouncedOptions<Immediate>,
): WatchHandle
export declare function watchDebounced<
  T extends object,
  Immediate extends Readonly<boolean> = false,
>(
  source: T,
  cb: WatchCallback<T, Immediate extends true ? T | undefined : T>,
  options?: WatchDebouncedOptions<Immediate>,
): WatchHandle
/** @deprecated use `watchDebounced` instead */
export declare const debouncedWatch: typeof watchDebounced

源码

源码 • 演示 • 文档

贡献者

一纸忘忧

更新日志

没有最近的更新日志