Files
stack/packages/mosaic/framework/skills/vueuse-functions/references/useSubject.md
T
fargo 1a822493ba format: apply repo prettier (3.8.1) to the folded skills tree
963 markdown files reformatted with the repository's pinned prettier so
pnpm format:check covers the folded tree like every other repo file.

The formatter's embedded-language pass also normalized code fences
(TS semicolons, closed HTML tags in examples, lowercased CSS hex colors,
one renumbered list that skipped an index). Alphanumeric token deltas vs
the fold commit were audited file-by-file; all are formatter-equivalent
markup normalizations plus the four sanitized skills.
2026-08-19 14:37:17 -05:00

1.3 KiB

category
category
@RxJS

useSubject

Bind an RxJS Subject to a ref and propagate value changes both ways.

Usage

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"
  },
});

Type Declarations

export interface UseSubjectOptions<I = undefined> extends Omit<
  UseObservableOptions<I>,
  'initialValue'
> {}
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>;