Ein DocumentSnapshot enthält Daten, die aus einem Dokument in Ihrer Firestore-Datenbank gelesen wurden. Die Daten können mit .data() oder .get(<field>) extrahiert werden, um ein bestimmtes Feld zu erhalten.
Bei einem DocumentSnapshot , der auf ein nicht vorhandenes Dokument verweist, gibt jeder Datenzugriff „undefiniert“ zurück. Sie können die Methode exists() verwenden, um die Existenz eines Dokuments explizit zu überprüfen.
Unterschrift:
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Konstrukteure
| Konstrukteur | Modifikatoren | Beschreibung |
|---|---|---|
| (Konstrukteur)() | Konstruiert eine neue Instanz der DocumentSnapshot Klasse |
Eigenschaften
| Eigentum | Modifikatoren | Typ | Beschreibung |
|---|---|---|---|
| Ausweis | Zeichenfolge | Eigenschaft des DocumentSnapshot , die die ID des Dokuments bereitstellt. | |
| ref | Dokumentverweis <AppModelType, DbModelType> | Die DocumentReference für das im DocumentSnapshot enthaltene Dokument. |
Methoden
| Methode | Modifikatoren | Beschreibung |
|---|---|---|
| Daten() | Ruft alle Felder im Dokument als Object ab. Gibt undefined zurück, wenn das Dokument nicht existiert. | |
| existiert() | Signalisiert, ob das Dokument am Speicherort des Snapshots vorhanden ist oder nicht. | |
| get(fieldPath) | Ruft das durch fieldPath angegebene Feld ab. Gibt undefined zurück, wenn das Dokument oder Feld nicht existiert. |
DocumentSnapshot.(Konstruktor)
Konstruiert eine neue Instanz der DocumentSnapshot Klasse
Unterschrift:
protected constructor();
DocumentSnapshot.id
Eigenschaft des DocumentSnapshot , die die ID des Dokuments bereitstellt.
Unterschrift:
get id(): string;
DocumentSnapshot.ref
Die DocumentReference für das im DocumentSnapshot enthaltene Dokument .
Unterschrift:
get ref(): DocumentReference<AppModelType, DbModelType>;
DocumentSnapshot.data()
Ruft alle Felder im Dokument als Object . Gibt undefined zurück, wenn das Dokument nicht existiert.
Unterschrift:
data(): AppModelType | undefined;
Kehrt zurück:
AppModelType | nicht definiert
Ein Object , das alle Felder im Dokument enthält oder undefined , wenn das Dokument nicht existiert.
DocumentSnapshot.exists()
Signalisiert, ob das Dokument am Speicherort des Snapshots vorhanden ist oder nicht.
Unterschrift:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
Kehrt zurück:
Dies ist QueryDocumentSnapshot <AppModelType, DbModelType>
true, wenn das Dokument vorhanden ist.
DocumentSnapshot.get()
Ruft das durch fieldPath angegebene Feld ab . Gibt undefined zurück, wenn das Dokument oder Feld nicht existiert.
Unterschrift:
get(fieldPath: string | FieldPath): any;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| fieldPath | Zeichenfolge | FieldPath | Der Pfad (zum Beispiel „foo“ oder „foo.bar“) zu einem bestimmten Feld. |
Kehrt zurück:
beliebig
Die Daten an der angegebenen Feldposition oder undefiniert, wenn im Dokument kein solches Feld vorhanden ist.