Skip to content

⬅️ Back to Table of Contents

📄 watchExtractedObservable

📊 Analysis Summary

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

📚 Table of Contents

🛠️ File Location:

📂 packages/rxjs/watchExtractedObservable/index.ts

📦 Imports

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

Vue Composition API

Name Type Reactive Variables Composables
watch watch none none

Functions

watchExtractedObservable(…): WatchHandle

Parameters:

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

    `

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

Returns: WatchHandle

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>,
): WatchHandle

Interfaces

WatchExtractedObservableOptions

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

Properties

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

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>;

Generated by Syntax Scribe