DocumentSnapshot
zawiera dane odczytane z dokumentu w bazie danych Firestore. Dane można wyodrębnić za pomocą .data()
lub .get(<field>)
, aby uzyskać określone pole.
W przypadku DocumentSnapshot
wskazującego nieistniejący dokument każdy dostęp do danych zwróci wartość „niezdefiniowany”. Możesz użyć metody exists()
, aby jawnie zweryfikować istnienie dokumentu.
Podpis:
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Konstruktorzy
Konstruktor | Modyfikatory | Opis |
---|---|---|
(konstruktor)() | Konstruuje nowe wystąpienie klasy DocumentSnapshot |
Nieruchomości
Nieruchomość | Modyfikatory | Typ | Opis |
---|---|---|---|
ID | strunowy | Właściwość DocumentSnapshot , która udostępnia identyfikator dokumentu. | |
metadane | SnapshotMetadata | Metadane dotyczące DocumentSnapshot , w tym informacje o jego źródle i lokalnych modyfikacjach. | |
ref | Odnośnik do dokumentu <AppModelType, DbModelType> | DocumentReference dokumentu zawartego w DocumentSnapshot . |
Metody
metoda | Modyfikatory | Opis |
---|---|---|
dane(opcje) | Pobiera wszystkie pola w dokumencie jako Object . Zwraca wartość undefined jeśli dokument nie istnieje. Domyślnie wartości serverTimestamp() , które nie zostały jeszcze ustawione na wartość końcową, zostaną zwrócone jako null . Można to zastąpić, przekazując obiekt opcji. | |
istnieje() | Zwraca informację, czy dane istnieją. Prawda, jeśli dokument istnieje. | |
get(fieldPath, opcje) | Pobiera pole określone przez fieldPath . Zwraca wartość undefined , jeśli dokument lub pole nie istnieje. Domyślnie funkcja serverTimestamp() , która nie została jeszcze ustawiona na wartość końcową, zostanie zwrócona jako null . Można to zastąpić, przekazując obiekt opcji. |
DocumentSnapshot.(konstruktor)
Konstruuje nowe wystąpienie klasy DocumentSnapshot
Podpis:
protected constructor();
DokumentSnapshot.id
Właściwość DocumentSnapshot
, która udostępnia identyfikator dokumentu.
Podpis:
get id(): string;
DokumentSnapshot.metadane
Metadane dotyczące DocumentSnapshot
, w tym informacje o jego źródle i lokalnych modyfikacjach.
Podpis:
readonly metadata: SnapshotMetadata;
DocumentSnapshot.ref
DocumentReference
dokumentu zawartego w DocumentSnapshot
.
Podpis:
get ref(): DocumentReference<AppModelType, DbModelType>;
DocumentSnapshot.data()
Pobiera wszystkie pola w dokumencie jako Object
. Zwraca wartość undefined
jeśli dokument nie istnieje.
Domyślnie wartości serverTimestamp()
, które nie zostały jeszcze ustawione na wartość końcową, zostaną zwrócone jako null
. Można to zastąpić, przekazując obiekt opcji.
Podpis:
data(options?: SnapshotOptions): AppModelType | undefined;
Parametry
Parametr | Typ | Opis |
---|---|---|
opcje | Opcje migawki | Obiekt opcji umożliwiający skonfigurowanie sposobu pobierania danych z migawki (na przykład pożądane zachowanie znaczników czasu serwera, które nie zostały jeszcze ustawione na wartość końcową). |
Zwroty:
Typ aplikacji | nieokreślony
Object
zawierający wszystkie pola w dokumencie lub undefined
jeśli dokument nie istnieje.
DocumentSnapshot.exists()
Zwraca informację, czy dane istnieją. Prawda, jeśli dokument istnieje.
Podpis:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
Zwroty:
to jest zrzut QueryDocumentSnapshot <AppModelType, DbModelType>
DocumentSnapshot.get()
Pobiera pole określone przez fieldPath
. Zwraca wartość undefined
, jeśli dokument lub pole nie istnieje.
Domyślnie serverTimestamp()
, która nie została jeszcze ustawiona na wartość końcową, zostanie zwrócona jako null
. Można to zastąpić, przekazując obiekt opcji.
Podpis:
get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;
Parametry
Parametr | Typ | Opis |
---|---|---|
poleŚcieżka | ciąg | Ścieżka pola | Ścieżka (na przykład „foo” lub „foo.bar”) do określonego pola. |
opcje | Opcje migawki | Obiekt opcji umożliwiający skonfigurowanie sposobu pobierania pola ze migawki (na przykład pożądane zachowanie znaczników czasu serwera, które nie zostały jeszcze ustawione na wartość końcową). |
Zwroty:
każdy
Dane w określonej lokalizacji pola lub niezdefiniowane, jeśli w dokumencie nie ma takiego pola.