Skip to content
On this page

toObserver

Category
Package
@vueuse/rxjs
Last Changed
6 months ago

Sugar function to convert a ref in an observer available in add-on @vueuse/rxjs

Usage

import { ref } from 'vue'
import { useSubscription, toObserver, fromEvent, from } from '@vueuse/rxjs'
import { interval } from 'rxjs'
import { mapTo, takeUntil, withLatestFrom, map } from 'rxjs/operators'

const count = ref(0)
const button = ref<HTMLButtonElement>(null)

useSubscription(
  interval(1000)
    .pipe(
      mapTo(1),
      takeUntil(fromEvent(button, 'click')),
      withLatestFrom(from(count).pipe(startWith(0))),
      map(([total, curr]) => curr + total),
    )
    .subscribe(toObserver(count)) // same as ).subscribe(val => (count.value = val))
)
import { ref } from 'vue'
import { useSubscription, toObserver, fromEvent, from } from '@vueuse/rxjs'
import { interval } from 'rxjs'
import { mapTo, takeUntil, withLatestFrom, map } from 'rxjs/operators'

const count = ref(0)
const button = ref<HTMLButtonElement>(null)

useSubscription(
  interval(1000)
    .pipe(
      mapTo(1),
      takeUntil(fromEvent(button, 'click')),
      withLatestFrom(from(count).pipe(startWith(0))),
      map(([total, curr]) => curr + total),
    )
    .subscribe(toObserver(count)) // same as ).subscribe(val => (count.value = val))
)

Type Declarations

export declare function toObserver<T>(value: Ref<T>): NextObserver<T>
export declare function toObserver<T>(value: Ref<T>): NextObserver<T>

Source

SourceDocs

Contributors

Anthony Fu
yang
Michel Betancourt

Changelog

v6.3.2 on 9/8/2021
4fbe8 - fix: update linter rule, close #729
toObserver has loaded