⬅️ Back to Table of Contents

📄 index.ts

📊 Analysis Summary

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

📚 Table of Contents

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

🛠️ File Location:

📂 packages/rxjs/watchExtractedObservable/index.ts

📦 Imports

Name	Source
MapOldSources	@vueuse/shared
MapSources	@vueuse/shared
MultiWatchSources	@vueuse/shared
Observable	rxjs
Subscription	rxjs
WatchOptions	vue
WatchSource	vue
WatchStopHandle	vue
tryOnScopeDispose	@vueuse/shared
watch	vue

---

Variables & Constants

Name	Type	Kind	Value	Exported
subscription	Subscription | undefined	let/var	*not shown*	✗

---

Vue Composition API

Name	Type	Reactive Variables	Composables
watch	watch	none	none

---

Functions

`watchExtractedObservable(sources: [...T], extractor: WatchExtractedObservableCallback<

MapSources<T>,
MapOldSources<T, Immediate>,
E

, callback: (snapshot: E) => void, subscriptionOptions: WatchExtractedObservableOptions, watchOptions: WatchOptions): WatchStopHandle`

Code

export function watchExtractedObservable<
  T extends MultiWatchSources,
  E,
  Immediate extends Readonly<boolean> = false,
>(
  sources: [...T],
  extractor: WatchExtractedObservableCallback<
    MapSources<T>,
    MapOldSources<T, Immediate>,
    E
  >,
  callback: (snapshot: E) => void,
  subscriptionOptions?: WatchExtractedObservableOptions,
  watchOptions?: WatchOptions<Immediate>
): WatchStopHandle

• Parameters:
• sources: [...T]
• `extractor: WatchExtractedObservableCallback< MapSources, MapOldSources, E

  `

• callback: (snapshot: E) => void
• subscriptionOptions: WatchExtractedObservableOptions
• watchOptions: WatchOptions<Immediate>
• Return Type: WatchStopHandle

---

Interfaces

WatchExtractedObservableOptions

Interface Code

export interface WatchExtractedObservableOptions {
  onError?: (err: unknown) => void
  onComplete?: () => void
}

Properties

Name	Type	Optional	Description
onError	(err: unknown) => void	✓
onComplete	() => void	✓

---

Type Aliases

OnCleanup

type OnCleanup = (cleanupFn: () => void) => void;

WatchExtractedObservableCallback<Value, OldValue, ObservableElement>

type WatchExtractedObservableCallback<Value, OldValue, ObservableElement> = (value: NonNullable<Value>, oldValue: OldValue, onCleanup: OnCleanup) => Observable<ObservableElement>;

---