preloadFirestoreDoc.md

ReactFire reference docs

---

ReactFire reference docs / preloadFirestoreDoc

Function: preloadFirestoreDoc()

preloadFirestoreDoc(refProvider): Promise<SuspenseSubject<DocumentSnapshot<DocumentData, DocumentData>>>

Defined in: src/firestore.tsx:28

Preload a subscription to a Firestore document reference.

Use this to warm up useFirestoreDoc for a specific document

Parameters

refProvider

() => Promise<DocumentReference<DocumentData, DocumentData>>

Returns

Promise<SuspenseSubject<DocumentSnapshot<DocumentData, DocumentData>>>