53 lines
1.3 KiB
Markdown
53 lines
1.3 KiB
Markdown
---
|
|
category: '@RxJS'
|
|
---
|
|
|
|
# useSubject
|
|
|
|
Bind an RxJS [`Subject`](https://rxjs.dev/guide/subject) to a `ref` and propagate value changes both ways.
|
|
|
|
## Usage
|
|
|
|
<!-- TODO: import rxjs error if enable twoslash -->
|
|
|
|
```ts no-twoslash
|
|
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).
|
|
|
|
```ts no-twoslash
|
|
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
|
|
|
|
```ts
|
|
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>
|
|
```
|