stack/v1/packages/mosaic/framework/skills/vueuse-functions/references/from.md

category

category
@RxJS

from / fromEvent

Wrappers around RxJS's from() and fromEvent() to allow them to accept refs.

Usage

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

const count = shallowRef(0);
const button = useTemplateRef('buttonRef');

useSubscription(
  interval(1000)
    .pipe(
      mapTo(1),
      takeUntil(fromEvent(button, 'click')),
      withLatestFrom(
        from(count, {
          immediate: true,
          deep: false,
        }),
      ),
      map(([curr, total]) => 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 | null>(
  value: MaybeRef<T>,
  event: string,
): Observable<Event>;