DocumentSnapshot class

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

Eigenschaften

Methoden

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.metadata

Metadaten zum DocumentSnapshot , einschließlich Informationen über seine Quelle und lokale Änderungen.

Unterschrift:

readonly metadata: SnapshotMetadata;

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.

Standardmäßig werden serverTimestamp() Werte, die noch nicht auf ihren endgültigen Wert gesetzt wurden, als null zurückgegeben . Sie können dies überschreiben, indem Sie ein Optionsobjekt übergeben.

Unterschrift:

data(options?: SnapshotOptions): AppModelType | undefined;

Parameter

Kehrt zurück:

AppModelType | nicht definiert

Ein Object , das alle Felder im Dokument enthält oder undefined , wenn das Dokument nicht existiert.

DocumentSnapshot.exists()

Gibt zurück, ob die Daten vorhanden sind oder nicht. True, wenn das Dokument vorhanden ist.

Unterschrift:

exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;

Kehrt zurück:

Dies ist QueryDocumentSnapshot <AppModelType, DbModelType>

DocumentSnapshot.get()

Ruft das durch fieldPath angegebene Feld ab . Gibt undefined zurück, wenn das Dokument oder Feld nicht vorhanden ist.

Standardmäßig wird ein serverTimestamp() , der noch nicht auf seinen endgültigen Wert gesetzt wurde, als null zurückgegeben . Sie können dies überschreiben, indem Sie ein Optionsobjekt übergeben.

Unterschrift:

get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;

Parameter

Kehrt zurück:

beliebig

Die Daten an der angegebenen Feldposition oder undefiniert, wenn im Dokument kein solches Feld vorhanden ist.