react-query-firebase / web/firestore / getDocSnap

Function: getDocSnap()

function getDocSnap<AppModelType>(options): Promise<null | DocumentSnapshot<AppModelType, AppModelType>>;

Defined in: web/firestore/utils/getDocSnap.ts:21

Asynchronously retrieves a document snapshot from Firestore using a specified document reference or path information. This function handles getting the appropriate document reference based on the parameters provided, and then fetches the document data from Firestore.

Type Parameters

AppModelType

AppModelType extends AppModel = AppModel

Parameters

options

The options for retrieving the document snapshot

db

Firestore

path?

string

pathSegments?

string[]

reference?

| CollectionReference<AppModelType, AppModelType> | DocumentReference<AppModelType, AppModelType>

Returns

Promise<null | DocumentSnapshot<AppModelType, AppModelType>>

Returns a document reference