⬅️ Back to Table of Contents

📄 watchDebounced

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	11
📊 Variables & Constants	1
📐 Interfaces	1

📚 Table of Contents

• Imports
• Variables & Constants
• Functions
• Interfaces

🛠️ File Location:

📂 packages/shared/watchDebounced/index.ts

📦 Imports

Name	Source
MaybeRefOrGetter	vue
MultiWatchSources	vue
WatchCallback	vue
WatchHandle	vue
WatchOptions	vue
WatchSource	vue
DebounceFilterOptions	../utils
MapOldSources	../utils
MapSources	../utils
debounceFilter	../utils
watchWithFilter	../watchWithFilter

---

Variables & Constants

Name	Type	Kind	Value	Exported
debouncedWatch	{ <T, Immediate extends Readonly<bool...	const	watchDebounced	✓

---

Functions

watchDebounced(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true…, options: WatchDebouncedOptions<Immediate>): WatchHandle

Parameters:

• source WatchSource<T>
• cb WatchCallback<T, Immediate extends true ? T | undefined : T>
• options WatchDebouncedOptions<Immediate>

Returns: WatchHandle

Code

export function watchDebounced<T, Immediate extends Readonly<boolean> = false>(
  source: WatchSource<T>,
  cb: WatchCallback<T, Immediate extends true ? T | undefined : T>,
  options?: WatchDebouncedOptions<Immediate>,
): WatchHandle

---

Interfaces

WatchDebouncedOptions<Immediate>

Interface Code

export interface WatchDebouncedOptions<Immediate> extends WatchOptions<Immediate>, DebounceFilterOptions {
  debounce?: MaybeRefOrGetter<number>
}

Properties

Name	Type	Optional	Description
debounce	MaybeRefOrGetter<number>	✓	not shown

---

Generated by Syntax Scribe