⬅️ Back to Table of Contents

📄 index.ts

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	10
📐 Interfaces	1
📑 Type Aliases	1

📚 Table of Contents

• Imports
• Functions
• Interfaces
• Type Aliases

🛠️ File Location:

📂 packages/shared/watchPausable/index.ts

📦 Imports

Name	Source
WatchCallback	vue
WatchSource	vue
WatchStopHandle	vue
MapOldSources	../utils
MapSources	../utils
Pausable	../utils
PausableFilterOptions	../utils
WatchWithFilterOptions	../watchWithFilter
pausableFilter	../utils
watchWithFilter	../watchWithFilter

---

Functions

watchPausable(sources: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options: WatchPausableOptions<Immediate>): WatchPausableReturn

Code

export function watchPausable<T extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options?: WatchPausableOptions<Immediate>): WatchPausableReturn

• Parameters:
• sources: [...T]
• cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>
• options: WatchPausableOptions<Immediate>
• Return Type: WatchPausableReturn

---

Interfaces

WatchPausableReturn

Interface Code

export interface WatchPausableReturn extends Pausable {
  stop: WatchStopHandle
}

Properties

Name	Type	Optional	Description
stop	WatchStopHandle	✗

---

Type Aliases

WatchPausableOptions<Immediate>

type WatchPausableOptions<Immediate> = WatchWithFilterOptions<Immediate> & PausableFilterOptions;

---