⬅️ Back to Table of Contents

📄 watchIgnorable

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	11
📊 Variables & Constants	1
🟢 Vue Composition API	3
📐 Interfaces	1
📑 Type Aliases	2

📚 Table of Contents

• Imports
• Variables & Constants
• Vue Composition API
• Functions
• Interfaces
• Type Aliases

🛠️ File Location:

📂 packages/shared/watchIgnorable/index.ts

📦 Imports

Name	Source
MultiWatchSources	vue
WatchCallback	vue
WatchSource	vue
WatchStopHandle	vue
Fn	../utils
MapOldSources	../utils
MapSources	../utils
WatchWithFilterOptions	../watchWithFilter
watch	vue
bypassFilter	../utils
createFilterWrapper	../utils

---

Variables & Constants

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

---

Vue Composition API

Name	Type	Reactive Variables	Composables
watch	watch	none	none
watch	watch	none	none
watch	watch	none	none

---

Functions

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

Parameters:

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

Returns: WatchIgnorableReturn

Code

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

---

Interfaces

WatchIgnorableReturn

Interface Code

export interface WatchIgnorableReturn {
  ignoreUpdates: IgnoredUpdater
  ignorePrevAsyncUpdates: IgnoredPrevAsyncUpdates
  stop: WatchStopHandle
}

Properties

Name	Type	Optional	Description
ignoreUpdates	IgnoredUpdater	✗	not shown
ignorePrevAsyncUpdates	IgnoredPrevAsyncUpdates	✗	not shown
stop	WatchStopHandle	✗	not shown

---

Type Aliases

IgnoredUpdater

type IgnoredUpdater = (updater: () => void) => void;

IgnoredPrevAsyncUpdates

type IgnoredPrevAsyncUpdates = () => void;

---

Generated by Syntax Scribe