VueUse中文文档watchDebounced
防抖 watch
Debounced watch
例子
delay设置为1000ms, maxWait设置为5000ms。
输入:
更新的次数: 0
Usage
类似于 watch，但提供了额外的选项 debounce 和 maxWait，这些选项将作用于回调函数。
Similar to watch, but offering extra options debounce and maxWait which will be applied to the callback function.
ts
import { watchDebounced } from '@vueuse/core'
watchDebounced(
source,
() => { console.log('changed!') },
{ debounce: 500, maxWait: 1000 },
)
import { watchDebounced } from '@vueuse/core'
watchDebounced(
source,
() => { console.log('changed!') },
{ debounce: 500, maxWait: 1000 },
)
本质上是以下代码的简写：
It's essentially a shorthand for the following code:
ts
import { debounceFilter, watchWithFilter } from '@vueuse/core'
watchWithFilter(
source,
() => { console.log('changed!') },
{
eventFilter: debounceFilter(500, { maxWait: 1000 }),
},
)
import { debounceFilter, watchWithFilter } from '@vueuse/core'
watchWithFilter(
source,
() => { console.log('changed!') },
{
eventFilter: debounceFilter(500, { maxWait: 1000 }),
},
)
Type Declarations
typescript
export interface WatchDebouncedOptions<Immediate>
extends WatchOptions<Immediate>,
DebounceFilterOptions {
debounce?: MaybeComputedRef<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>
): WatchStopHandle
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>
): WatchStopHandle
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>
): WatchStopHandle
export { watchDebounced as debouncedWatch }
export interface WatchDebouncedOptions<Immediate>
extends WatchOptions<Immediate>,
DebounceFilterOptions {
debounce?: MaybeComputedRef<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>
): WatchStopHandle
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>
): WatchStopHandle
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>
): WatchStopHandle
export { watchDebounced as debouncedWatch }