VueUse

throttledWatch

Throttled watch.

Usage

Similar to watch, but offering an extra option throttle which will be applied to the callback function.

import { throttledWatch } from '@vueuse/core'

debouncedWatch(
  source,
  () => { console.log('changed!') },
  { throttle: 500 }
)

It's essentially a shorthand for the following code:

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

watchWithFilter(
  source,
  () => { console.log('changed!') },
  {
    eventFilter: throttleFilter(500),
  }
)

Type Declarations

export interface ThrottledWatchOptions<Immediate>
  extends WatchOptions<Immediate> {
  throttle?: number
}
export declare function throttledWatch<
  T extends Readonly<WatchSource<unknown>[]>,
  Immediate extends Readonly<boolean> = false
>(
  sources: T,
  cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>,
  options?: ThrottledWatchOptions<Immediate>
): WatchStopHandle
export declare function throttledWatch<
  T,
  Immediate extends Readonly<boolean> = false
>(
  source: WatchSource<T>,
  cb: WatchCallback<T, Immediate extends true ? T | undefined : T>,
  options?: ThrottledWatchOptions<Immediate>
): WatchStopHandle
export declare function throttledWatch<
  T extends object,
  Immediate extends Readonly<boolean> = false
>(
  source: T,
  cb: WatchCallback<T, Immediate extends true ? T | undefined : T>,
  options?: ThrottledWatchOptions<Immediate>
): WatchStopHandle

Source

Source • Docs