Skip to content
On this page

from / fromEvent

Two wrappers around of the original functions to allow use ref objects available in add-on @vueuse/rxjs

Usage

Category
Package
@vueuse/rxjs
Last Changed
5 months ago
import { ref } from 'vue'
import { from, fromEvent, toObserver, useSubscription } from '@vueuse/rxjs'
import { interval } from 'rxjs'
import { map, mapTo, takeUntil, withLatestFrom } 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, {
        immediate: true,
        deep: false,
      })),
      map(([total, curr]) => curr + total),
    )
    .subscribe(toObserver(count)), // same as ).subscribe(val => (count.value = val))
)
import { ref } from 'vue'
import { from, fromEvent, toObserver, useSubscription } from '@vueuse/rxjs'
import { interval } from 'rxjs'
import { map, mapTo, takeUntil, withLatestFrom } 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, {
        immediate: true,
        deep: false,
      })),
      map(([total, curr]) => curr + total),
    )
    .subscribe(toObserver(count)), // same as ).subscribe(val => (count.value = val))
)

Type Declarations

export declare function from<T>(
  value: ObservableInput<T> | Ref<T>,
  watchOptions?: WatchOptions
): Observable<T>
export declare function fromEvent<T extends HTMLElement>(
  value: Ref<T>,
  event: string
): Observable<Event>
export declare function from<T>(
  value: ObservableInput<T> | Ref<T>,
  watchOptions?: WatchOptions
): Observable<T>
export declare function fromEvent<T extends HTMLElement>(
  value: Ref<T>,
  event: string
): Observable<Event>

Source

SourceDocs

Contributors

Anthony Fu
Alexander Karelas
DesselBane
yang
Michel Betancourt

Changelog

v7.5.0 on 12/31/2021
0af44 - fix(fromEvent): set immediate for from (issue #1099) (#1100)
v7.2.0 on 12/8/2021
fbcbe - feat(rxjs): improve rxjs from (#987)
v6.3.2 on 9/8/2021
4fbe8 - fix: update linter rule, close #729
from / fromEvent has loaded