⬅️ Back to Table of Contents

📄 useSubject

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	7
🟢 Vue Composition API	1
📐 Interfaces	1

📚 Table of Contents

• Imports
• Vue Composition API
• Functions
• Interfaces

🛠️ File Location:

📂 packages/rxjs/useSubject/index.ts

📦 Imports

Name	Source
Subject	rxjs
Ref	vue
UseObservableOptions	../useObservable
tryOnScopeDispose	@vueuse/shared
BehaviorSubject	rxjs
deepRef	vue
watch	vue

---

Vue Composition API

Name	Type	Reactive Variables	Composables
watch	watch	none	none

---

Functions

useSubject(subject: BehaviorSubject<H>, options: UseSubjectOptions): Ref<H>

Parameters:

• subject BehaviorSubject<H>
• options UseSubjectOptions

Returns: Ref<H>

Code

export function useSubject<H>(subject: BehaviorSubject<H>, options?: UseSubjectOptions): Ref<H>

---

Interfaces

UseSubjectOptions<I = undefined>

Interface Code

export interface UseSubjectOptions<I = undefined> extends Omit<UseObservableOptions<I>, 'initialValue'> {
}

---

Generated by Syntax Scribe