⬅️ Back to Table of Contents

📄 index.ts

📊 Analysis Summary

Metric	Count
🔧 Functions	4
📦 Imports	15
📊 Variables & Constants	2
🟢 Vue Composition API	2
📐 Interfaces	1
📑 Type Aliases	2

📚 Table of Contents

• Imports
• Variables & Constants
• Vue Composition API
• Functions
• Interfaces
• Type Aliases

🛠️ File Location:

📂 packages/firebase/useFirestore/index.ts

📦 Imports

Name	Source
DocumentData	firebase/firestore
DocumentReference	firebase/firestore
DocumentSnapshot	firebase/firestore
Query	firebase/firestore
QueryDocumentSnapshot	firebase/firestore
MaybeRef	vue
Ref	vue
isDef	@vueuse/shared
tryOnScopeDispose	@vueuse/shared
useTimeoutFn	@vueuse/shared
onSnapshot	firebase/firestore
computed	vue
deepRef	vue
isRef	vue
watch	vue

---

Variables & Constants

Name	Type	Kind	Value	Exported
refOfDocRef	any	const	`isRef(maybeDocRef)
? maybeDocRef
: computed(() => maybeDocRef)`	✗
data	Ref<T | T[]>	const	deepRef(initialValue) as Ref<T | T[] | null | undefined>	✗

---

Vue Composition API

Name	Type	Reactive Variables	Composables
computed	computed	none	none
watch	watch	none	none

---

Functions

getData(docRef: DocumentSnapshot<T> | QueryDocumentSnapshot<T>): any

Code

function getData<T>(
  docRef: DocumentSnapshot<T> | QueryDocumentSnapshot<T>,
) {
  const data = docRef.data()

  if (data) {
    Object.defineProperty(data, 'id', {
      value: docRef.id.toString(),
      writable: false,
    })
  }

  return data
}

• Parameters:
• docRef: DocumentSnapshot<T> | QueryDocumentSnapshot<T>
• Return Type: any
• Calls:
• docRef.data
• Object.defineProperty
• docRef.id.toString

isDocumentReference(docRef: any): docRef is DocumentReference<T>

Code

function isDocumentReference<T>(docRef: any): docRef is DocumentReference<T> {
  return (docRef.path?.match(/\//g) || []).length % 2 !== 0
}

• Parameters:
• docRef: any
• Return Type: docRef is DocumentReference<T>
• Calls:
• docRef.path?.match

useFirestore(maybeDocRef: MaybeRef<DocumentReference<T> | Falsy>, initialValue: T, options: UseFirestoreOptions): Ref<T | null>

Code

export function useFirestore<T extends DocumentData>(
  maybeDocRef: MaybeRef<DocumentReference<T> | Falsy>,
  initialValue: T,
  options?: UseFirestoreOptions
): Ref<T | null>

• Parameters:
• maybeDocRef: MaybeRef<DocumentReference<T> | Falsy>
• initialValue: T
• options: UseFirestoreOptions
• Return Type: Ref<T | null>

close(): void

Code

() => { }

• Return Type: void

---

Interfaces

UseFirestoreOptions

Interface Code

export interface UseFirestoreOptions {
  errorHandler?: (err: Error) => void
  autoDispose?: boolean | number
}

Properties

Name	Type	Optional	Description
errorHandler	(err: Error) => void	✓
autoDispose	boolean | number	✓

---

Type Aliases

FirebaseDocRef<T>

type FirebaseDocRef<T> = Query<T> |
  DocumentReference<T>;

Falsy

type Falsy = false | 0 | '' | null | undefined;

---