⬅️ Back to Table of Contents

📄 watchWithFilter

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	11
🟢 Vue Composition API	1
📐 Interfaces	1

📚 Table of Contents

• Imports
• Vue Composition API
• Functions
• Interfaces

🛠️ File Location:

📂 packages/shared/watchWithFilter/index.ts

📦 Imports

Name	Source
MultiWatchSources	vue
WatchCallback	vue
WatchHandle	vue
WatchOptions	vue
WatchSource	vue
ConfigurableEventFilter	../utils
MapOldSources	../utils
MapSources	../utils
watch	vue
bypassFilter	../utils
createFilterWrapper	../utils

---

Vue Composition API

Name	Type	Reactive Variables	Composables
watch	watch	none	none

---

Functions

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

Parameters:

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

Returns: WatchHandle

Code

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

---

Interfaces

WatchWithFilterOptions<Immediate>

Interface Code

export interface WatchWithFilterOptions<Immediate> extends WatchOptions<Immediate>, ConfigurableEventFilter {}

---

Generated by Syntax Scribe