Skip to content
On this page

useSubject

Category
Package
@vueuse/rxjs
Last Changed
a month ago

Bind Subject to ref and propagate value changes both ways.

Demo

source

available in add-on @vueuse/rxjs

Usage

import { useSubject } from '@vueuse/rxjs'
import { Subject } from 'rxjs'

const subject = new Subject()

// setup()
const subjectRef = useSubject(subject)
import { useSubject } from '@vueuse/rxjs'
import { Subject } from 'rxjs'

const subject = new Subject()

// setup()
const subjectRef = useSubject(subject)

If you want to add custom error handling to a Subject that might error, you can supply an optional onError configuration. Without this, RxJS will treat any error in the supplied observable as an "unhandled error" and it will be thrown in a new call stack and reported to window.onerror (or process.on('error') if you happen to be in node).

import { useSubject } from '@vueuse/rxjs'
import { Subject } from 'rxjs'

const subject = new Subject()

// setup()
const subjectRef = useSubject(subject,
  {
    onError: err => {
      console.log(err.message) // "oops"
    }
  }
)
import { useSubject } from '@vueuse/rxjs'
import { Subject } from 'rxjs'

const subject = new Subject()

// setup()
const subjectRef = useSubject(subject,
  {
    onError: err => {
      console.log(err.message) // "oops"
    }
  }
)

Type Declarations

export interface UseSubjectOptions extends UseObservableOptions {}
export declare function useSubject<H>(
  subject: BehaviorSubject<H>,
  options?: UseSubjectOptions
): Ref<H>
export declare function useSubject<H>(
  subject: Subject<H>,
  options?: UseSubjectOptions
): Ref<H | undefined>
export interface UseSubjectOptions extends UseObservableOptions {}
export declare function useSubject<H>(
  subject: BehaviorSubject<H>,
  options?: UseSubjectOptions
): Ref<H>
export declare function useSubject<H>(
  subject: Subject<H>,
  options?: UseSubjectOptions
): Ref<H | undefined>

Source

SourceDemoDocs

Contributors

Anthony Fu
Jiří Peterek

Changelog

v7.3.0 on 12/12/2021
edc8c - feat: new function (#1012)
useSubject has loaded