Eine DocumentReference verweist auf einen Dokumentspeicherort in einer Firestore-Datenbank und kann zum Schreiben, Lesen oder Abhören des Speicherorts verwendet werden. Das Dokument am angegebenen Speicherort kann vorhanden sein oder auch nicht.
Unterschrift:
export declare class DocumentReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Eigenschaften
| Eigentum | Modifikatoren | Typ | Beschreibung |
|---|---|---|---|
| Konverter | FirestoreDataConverter <AppModelType, DbModelType> | Null | Falls angegeben, der dieser Instanz zugeordnete FirestoreDataConverter . | |
| Feuerladen | Feuerladen | Die Firestore- Instanz, in der sich das Dokument befindet. Dies ist beispielsweise für die Durchführung von Transaktionen nützlich. | |
| Ausweis | Zeichenfolge | Der Bezeichner des Dokuments innerhalb seiner Sammlung. | |
| Elternteil | CollectionReference <AppModelType, DbModelType> | Die Sammlung, zu der diese DocumentReference gehört. | |
| Weg | Zeichenfolge | Eine Zeichenfolge, die den Pfad des referenzierten Dokuments darstellt (relativ zum Stammverzeichnis der Datenbank). | |
| Typ | (Nicht deklariert) | Der Typ dieser Firestore-Referenz. |
Methoden
| Methode | Modifikatoren | Beschreibung |
|---|---|---|
| withConverter(Konverter) | Wendet einen benutzerdefinierten Datenkonverter auf diese DocumentReference an, sodass Sie Ihre eigenen benutzerdefinierten Modellobjekte mit Firestore verwenden können. Wenn Sie setDoc() aufrufen , getDoc() usw. mit der zurückgegebenen DocumentReference Instanz konvertiert der bereitgestellte Konverter zwischen Firestore-Daten vom Typ NewDbModelType und Ihrem benutzerdefinierten Typ NewAppModelType . | |
| withConverter(Konverter) | Entfernt den aktuellen Konverter. |
DocumentReference.converter
Falls angegeben, der dieser Instanz zugeordnete FirestoreDataConverter .
Unterschrift:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
DocumentReference.firestore
Die Firestore- Instanz, in der sich das Dokument befindet. Dies ist beispielsweise für die Durchführung von Transaktionen nützlich.
Unterschrift:
readonly firestore: Firestore;
DocumentReference.id
Der Bezeichner des Dokuments innerhalb seiner Sammlung.
Unterschrift:
get id(): string;
DocumentReference.parent
Die Sammlung, zu der diese DocumentReference gehört.
Unterschrift:
get parent(): CollectionReference<AppModelType, DbModelType>;
DocumentReference.path
Eine Zeichenfolge, die den Pfad des referenzierten Dokuments darstellt (relativ zum Stammverzeichnis der Datenbank).
Unterschrift:
get path(): string;
DocumentReference.type
Der Typ dieser Firestore-Referenz.
Unterschrift:
readonly type = "document";
DocumentReference.withConverter()
Wendet einen benutzerdefinierten Datenkonverter auf diese DocumentReference an , sodass Sie Ihre eigenen benutzerdefinierten Modellobjekte mit Firestore verwenden können. Wenn Sie setDoc() aufrufen , getDoc() usw. mit der zurückgegebenen DocumentReference Instanz konvertiert der bereitgestellte Konverter zwischen Firestore-Daten vom Typ NewDbModelType und Ihrem benutzerdefinierten Typ NewAppModelType .
Unterschrift:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| Konverter | FirestoreDataConverter <NewAppModelType, NewDbModelType> | Konvertiert Objekte in und aus Firestore. |
Kehrt zurück:
Dokumentverweis <NewAppModelType, NewDbModelType>
Eine DocumentReference , die den bereitgestellten Konverter verwendet.
DocumentReference.withConverter()
Entfernt den aktuellen Konverter.
Unterschrift:
withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| Konverter | Null | null entfernt den aktuellen Konverter. |
Kehrt zurück:
Dokumentverweis < Dokumentdaten , Dokumentdaten >
Eine DocumentReference<DocumentData, DocumentData> , die keinen Konverter verwendet.