watchDebounced

类别

Watch

导出体积

455 B

上次更改

2 days ago

别名

debouncedWatch

延迟触发的监听器

示例

源码playground (beta)

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

输入内容：

更新次数：0

使用方法

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

import { watchDebounced } from '@vueuse/core'

watchDebounced(
  source,
  () => { console.log('变化了！') },
  { debounce: 500, maxWait: 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<WatchSource<unknown>[]>,
  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

源码

源码 • 演示 • 文档

贡献者

一纸忘忧

Anthony Fu

Anthony Fu

sun0day

webfansplz

Arthur Darkstone

Vida Xie

IlyaL

James Garbutt

OrbisK

vaakian X

lvjiaxuan

更新日志

v14.0.0-alpha.3 on

b8102 - feat(watch): update watch return typo in watchExtractedObservable, watchDebounced, watchDeep, watchImmediate, watchOnce, watchThrottled and watchWithFilter (#4896)

v14.0.0-alpha.2 on

e5f74 - feat!: deprecate alias exports in favor of original function names (#5009)

v12.8.0 on

7432f - feat(types): deprecate MaybeRef and MaybeRefOrGetter in favor of Vue's native (#4636)

v12.0.0-beta.1 on

0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)