Ein CollectionReference Objekt kann zum Hinzufügen von Dokumenten, zum Abrufen von Dokumentverweisen und zum Abfragen von Dokumenten (mit query()) verwendet werden. ).
Unterschrift:
export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType>
Erweitert: Abfrage <AppModelType, DbModelType>
Eigenschaften
| Eigentum | Modifikatoren | Typ | Beschreibung |
|---|---|---|---|
| Ausweis | Zeichenfolge | Der Bezeichner der Sammlung. | |
| Elternteil | Dokumentverweis < Dokumentdaten , Dokumentdaten > | Null | Ein Verweis auf die enthaltende DocumentReference wenn es sich um eine Untersammlung handelt. Wenn es sich nicht um eine Untersammlung handelt, ist die Referenz null. | |
| Weg | Zeichenfolge | Eine Zeichenfolge, die den Pfad der referenzierten Sammlung 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 CollectionReference an, sodass Sie Ihre eigenen benutzerdefinierten Modellobjekte mit Firestore verwenden können. Wenn Sie addDoc() mit der zurückgegebenen CollectionReference Instanz aufrufen, konvertiert der bereitgestellte Konverter zwischen Firestore-Daten vom Typ NewDbModelType und Ihrem benutzerdefinierten Typ NewAppModelType . | |
| withConverter(Konverter) | Entfernt den aktuellen Konverter. |
CollectionReference.id
Der Bezeichner der Sammlung.
Unterschrift:
get id(): string;
CollectionReference.parent
Ein Verweis auf die enthaltende DocumentReference wenn es sich um eine Untersammlung handelt. Wenn es sich nicht um eine Untersammlung handelt, ist die Referenz null.
Unterschrift:
get parent(): DocumentReference<DocumentData, DocumentData> | null;
CollectionReference.path
Eine Zeichenfolge, die den Pfad der referenzierten Sammlung darstellt (relativ zum Stammverzeichnis der Datenbank).
Unterschrift:
get path(): string;
CollectionReference.type
Der Typ dieser Firestore-Referenz.
Unterschrift:
readonly type = "collection";
CollectionReference.withConverter()
Wendet einen benutzerdefinierten Datenkonverter auf diese CollectionReference an , sodass Sie Ihre eigenen benutzerdefinierten Modellobjekte mit Firestore verwenden können. Wenn Sie addDoc() mit der zurückgegebenen CollectionReference Instanz aufrufen, 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>): CollectionReference<NewAppModelType, NewDbModelType>;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| Konverter | FirestoreDataConverter <NewAppModelType, NewDbModelType> | Konvertiert Objekte in und aus Firestore. |
Kehrt zurück:
CollectionReference <NewAppModelType, NewDbModelType>
Eine CollectionReference , die den bereitgestellten Konverter verwendet.
CollectionReference.withConverter()
Entfernt den aktuellen Konverter.
Unterschrift:
withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| Konverter | Null | null entfernt den aktuellen Konverter. |
Kehrt zurück:
CollectionReference < Dokumentdaten , Dokumentdaten >
Eine CollectionReference<DocumentData, DocumentData> , die keinen Konverter verwendet.