_firestore_.md

reactfire

Globals / "firestore"

Module: "firestore"

Index

Variables

• cachedQueries

Functions

• getUniqueIdForFirestoreQuery
• preloadFirestoreDoc
• useFirestoreCollection
• useFirestoreCollectionData
• useFirestoreDoc
• useFirestoreDocData
• useFirestoreDocDataOnce
• useFirestoreDocOnce

Variables

cachedQueries

• Const cachedQueries: Array<Query> = ((globalThis as any) as ReactFireGlobals)._reactFireFirestoreQueryCache || []

Defined in src/firestore.tsx:9

Functions

getUniqueIdForFirestoreQuery

▸ getUniqueIdForFirestoreQuery(query: Query): number

Defined in src/firestore.tsx:15

Parameters:

Name	Type
query	Query

Returns: number

---

preloadFirestoreDoc

▸ preloadFirestoreDoc(refProvider: (firestore: Firestore) => DocumentReference, options?: undefined | { firebaseApp?: firebase.app.App }): Promise<SuspenseSubject<DocumentSnapshot>>

Defined in src/firestore.tsx:29

Parameters:

Name	Type
refProvider	(firestore: Firestore) => DocumentReference
options?	undefined | { firebaseApp?: firebase.app.App }

Returns: Promise<SuspenseSubject<DocumentSnapshot>>

---

useFirestoreCollection

▸ useFirestoreCollection<T>(query: Query, options?: ReactFireOptions<T[]>): ObservableStatus<T extends {} ? T[] : QuerySnapshot>

Defined in src/firestore.tsx:110

Subscribe to a Firestore collection

Type parameters:

Name	Default
T	{ [key:string]: unknown; }

Parameters:

Name	Type	Description
query	Query	-
options?	ReactFireOptions<T[]>

Returns: ObservableStatus<T extends {} ? T[] : QuerySnapshot>

---

useFirestoreCollectionData

▸ useFirestoreCollectionData<T>(query: Query, options?: ReactFireOptions<T[]>): ObservableStatus<T[]>

Defined in src/firestore.tsx:126

Subscribe to a Firestore collection and unwrap the snapshot.

Type parameters:

Name	Default
T	{ [key:string]: unknown; }

Parameters:

Name	Type	Description
query	Query	-
options?	ReactFireOptions<T[]>

Returns: ObservableStatus<T[]>

---

useFirestoreDoc

▸ useFirestoreDoc<T>(ref: DocumentReference, options?: ReactFireOptions<T>): ObservableStatus<T extends {} ? T : DocumentSnapshot>

Defined in src/firestore.tsx:48

Suscribe to Firestore Document changes

Type parameters:

Name	Default
T	unknown

Parameters:

Name	Type	Description
ref	DocumentReference	Reference to the document you want to listen to
options?	ReactFireOptions<T>

Returns: ObservableStatus<T extends {} ? T : DocumentSnapshot>

---

useFirestoreDocData

▸ useFirestoreDocData<T>(ref: DocumentReference, options?: ReactFireOptions<T>): ObservableStatus<T>

Defined in src/firestore.tsx:80

Suscribe to Firestore Document changes

Type parameters:

Name
T

Parameters:

Name	Type	Description
ref	DocumentReference	Reference to the document you want to listen to
options?	ReactFireOptions<T>

Returns: ObservableStatus<T>

---

useFirestoreDocDataOnce

▸ useFirestoreDocDataOnce<T>(ref: DocumentReference, options?: ReactFireOptions<T>): ObservableStatus<T>

Defined in src/firestore.tsx:95

Get a firestore document and don't subscribe to changes

Type parameters:

Name	Default
T	unknown

Parameters:

Name	Type	Description
ref	DocumentReference	Reference to the document you want to get
options?	ReactFireOptions<T>

Returns: ObservableStatus<T>

---

useFirestoreDocOnce

▸ useFirestoreDocOnce<T>(ref: DocumentReference, options?: ReactFireOptions<T>): ObservableStatus<T extends {} ? T : DocumentSnapshot>

Defined in src/firestore.tsx:64

Get a firestore document and don't subscribe to changes

Type parameters:

Name	Default
T	unknown

Parameters:

Name	Type	Description
ref	DocumentReference	Reference to the document you want to get
options?	ReactFireOptions<T>

Returns: ObservableStatus<T extends {} ? T : DocumentSnapshot>