watchExtractedObservable

カテゴリ

@RxJS

エクスポートサイズ

パッケージ

@vueuse/rxjs

最終変更

先週

1つ以上のコンポーザブルから抽出されたRxJS Observableの値を監視します。

Observableの変更時に自動的にサブスクライブを解除し、コンポーネントがアンマウントされたときに自動的にサブスクライブを解除します。

watchのすべてのオーバーロードをサポートします。@vueuse/rxjsアドオンで利用可能です。

使用方法

TypeScript

import { watchExtractedObservable } from '@vueuse/rxjs'
import { computed, ref } from 'vue'
import { AudioPlayer } from '../my/libs/AudioPlayer'

// setup()

const audio = ref<HTMLAudioElement>()
const player = computed(() => (audio.value ? new AudioPlayer(audio) : null))
const state = reactive({
  progress: 0,
})

watchExtractedObservable(player, p => p.progress$, (percentage) => {
  state.progress = percentage * 100
})

import { watchExtractedObservable } from '@vueuse/rxjs'
import { computed, ref } from 'vue'
import { AudioPlayer } from '../my/libs/AudioPlayer'
// setup()
const audio = ref()
const player = computed(() => (audio.value ? new AudioPlayer(audio) : null))
const state = reactive({
  progress: 0,
})
watchExtractedObservable(
  player,
  (p) => p.progress$,
  (percentage) => {
    state.progress = percentage * 100
  },
)

エラーが発生する可能性のあるObservableにカスタムエラー処理を追加したい場合は、オプションのonError設定を指定できます。これがない場合、RxJSは指定されたObservableのエラーを「未処理のエラー」として扱い、新しいコールスタックでスローされ、window.onerror（またはNodeの場合はprocess.on('error')）に報告されます。

監視対象のObservableが完了したときに特別な動作をアタッチする必要がある場合は、オプションのonComplete設定を指定することもできます。

TypeScript

import { watchExtractedObservable } from '@vueuse/rxjs'
import { computed, ref } from 'vue'
import { AudioPlayer } from '../my/libs/AudioPlayer'

// setup()

const audio = ref<HTMLAudioElement>()
const player = computed(() => (audio.value ? new AudioPlayer(audio) : null))
const state = reactive({
  progress: 0,
})

watchExtractedObservable(player, p => p.progress$, (percentage) => {
  state.progress = percentage * 100
}, {
  onError: (err: unknown) => {
    console.error(err)
  },
  onComplete: () => {
    state.progress = 100 // or 0, or whatever
  },
})

import { watchExtractedObservable } from '@vueuse/rxjs'
import { computed, ref } from 'vue'
import { AudioPlayer } from '../my/libs/AudioPlayer'
// setup()
const audio = ref()
const player = computed(() => (audio.value ? new AudioPlayer(audio) : null))
const state = reactive({
  progress: 0,
})
watchExtractedObservable(
  player,
  (p) => p.progress$,
  (percentage) => {
    state.progress = percentage * 100
  },
  {
    onError: (err) => {
      console.error(err)
    },
    onComplete: () => {
      state.progress = 100 // or 0, or whatever
    },
  },
)

必要に応じて、最後の引数としてwatchオプションを渡すこともできます。

TypeScript

import { watchExtractedObservable } from '@vueuse/rxjs'
import { computed, ref } from 'vue'
import { AudioPlayer } from '../my/libs/AudioPlayer'

// setup()

const audio = ref<HTMLAudioElement>()
const player = computed(() => (audio.value ? new AudioPlayer(audio) : null))
const state = reactive({
  progress: 0,
})

watchExtractedObservable(player, p => p.progress$, (percentage) => {
  state.progress = percentage * 100
}, {
  onError: (err: unknown) => {
    console.error(err)
  }
}, {
  immediate: true
})

import { watchExtractedObservable } from '@vueuse/rxjs'
import { computed, ref } from 'vue'
import { AudioPlayer } from '../my/libs/AudioPlayer'
// setup()
const audio = ref()
const player = computed(() => (audio.value ? new AudioPlayer(audio) : null))
const state = reactive({
  progress: 0,
})
watchExtractedObservable(
  player,
  (p) => p.progress$,
  (percentage) => {
    state.progress = percentage * 100
  },
  {
    onError: (err) => {
      console.error(err)
    },
  },
  {
    immediate: true,
  },
)

型宣言

型宣言を表示

typescript

export type OnCleanup = (cleanupFn: () => void) => void
export type WatchExtractedObservableCallback<
  Value,
  OldValue,
  ObservableElement,
> = (
  value: NonNullable<Value>,
  oldValue: OldValue,
  onCleanup: OnCleanup,
) => Observable<ObservableElement>
export interface WatchExtractedObservableOptions {
  onError?: (err: unknown) => void
  onComplete?: () => void
}
export declare 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
export declare function watchExtractedObservable<
  T extends Readonly<MultiWatchSources>,
  E,
  Immediate extends Readonly<boolean> = false,
>(
  source: T,
  extractor: WatchExtractedObservableCallback<
    MapSources<T>,
    MapOldSources<T, Immediate>,
    E
  >,
  callback: (snapshot: E) => void,
  subscriptionOptions?: WatchExtractedObservableOptions,
  watchOptions?: WatchOptions<Immediate>,
): WatchStopHandle
export declare function watchExtractedObservable<
  T,
  E,
  Immediate extends Readonly<boolean> = false,
>(
  source: WatchSource<T>,
  extractor: WatchExtractedObservableCallback<
    T,
    Immediate extends true ? T | undefined : T,
    E
  >,
  callback: (snapshot: E) => void,
  subscriptionOptions?: WatchExtractedObservableOptions,
  watchOptions?: WatchOptions<Immediate>,
): WatchStopHandle
export declare function watchExtractedObservable<
  T extends object,
  E,
  Immediate extends Readonly<boolean> = false,
>(
  source: T,
  extractor: WatchExtractedObservableCallback<
    T,
    Immediate extends true ? T | undefined : T,
    E
  >,
  callback: (snapshot: E) => void,
  subscriptionOptions?: WatchExtractedObservableOptions,
  watchOptions?: WatchOptions<Immediate>,
): WatchStopHandle