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. | |
ref | Odnośnik do dokumentu <AppModelType, DbModelType> | DocumentReference dokumentu zawartego w DocumentSnapshot . |
Metody
metoda | Modyfikatory | Opis |
---|---|---|
dane() | Pobiera wszystkie pola w dokumencie jako Object . Zwraca wartość undefined jeśli dokument nie istnieje. | |
istnieje() | Sygnalizuje, czy dokument w lokalizacji migawki istnieje. | |
pobierz (ścieżka pola) | Pobiera pole określone przez fieldPath . Zwraca wartość undefined , jeśli dokument lub pole nie istnieje. |
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;
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.
Podpis:
data(): AppModelType | undefined;
Zwroty:
Typ aplikacji | nieokreślony
Object
zawierający wszystkie pola w dokumencie lub undefined
jeśli dokument nie istnieje.
DocumentSnapshot.exists()
Sygnalizuje, czy dokument w lokalizacji migawki istnieje.
Podpis:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
Zwroty:
to jest zrzut QueryDocumentSnapshot <AppModelType, DbModelType>
true, jeśli dokument istnieje.
DocumentSnapshot.get()
Pobiera pole określone przez fieldPath
. Zwraca wartość undefined
, jeśli dokument lub pole nie istnieje.
Podpis:
get(fieldPath: string | FieldPath): 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. |
Zwroty:
każdy
Dane w określonej lokalizacji pola lub niezdefiniowane, jeśli w dokumencie nie ma takiego pola.