Element DocumentSnapshot zawiera dane odczytane z dokumentu w bazie danych Firestore. Dane można wyodrębnić za pomocą funkcji .data() lub .get(<field>), aby uzyskać określone pole.
W przypadku obiektu DocumentSnapshot wskazującego nieistniejący dokument, każdy dostęp do danych będzie zwracać wartość „niezdefiniowany”. Możesz użyć metody exists(), aby wprost zweryfikować istnienie dokumentu.
Podpis:
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Zespoły
| Zespół | Modyfikatory | Opis |
|---|---|---|
| (konstruktor)() | Tworzy nową instancję klasy DocumentSnapshot |
Właściwości
| Właściwość | Modyfikatory | Typ | Opis |
|---|---|---|---|
| id | ciąg znaków | Właściwość elementu DocumentSnapshot, który zawiera identyfikator dokumentu. |
|
| źródło | DocumentReference<AppModelType, DbModelType> | Pole DocumentReference dokumentu uwzględnione w pliku DocumentSnapshot. |
Metody
| Metoda | Modyfikatory | Opis |
|---|---|---|
| data() | Pobiera wszystkie pola w dokumencie jako Object. Zwraca wartość undefined, jeśli dokument nie istnieje. |
|
| exists() | Wskazuje, czy dokument w lokalizacji zrzutu ekranu istnieje. | |
| get(fieldPath) | Pobiera pole określone przez funkcję fieldPath. Zwraca wartość undefined, jeśli dokument lub pole nie istnieje. |
DocumentSnapshot.(konstruktor)
Tworzy nową instancję klasy DocumentSnapshot
Podpis:
protected constructor();
DocumentSnapshot.id
Właściwość elementu DocumentSnapshot, który zawiera identyfikator dokumentu.
Podpis:
get id(): string;
DocumentSnapshot.ref
Pole DocumentReference dokumentu zawarte 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:
AppModelType | nie zdefiniowano
Pole Object zawierające wszystkie pola w dokumencie lub undefined, jeśli dokument nie istnieje.
DocumentSnapshot.exists()
Wskazuje, czy dokument w lokalizacji zrzutu ekranu istnieje.
Podpis:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
Zwroty:
to QueryDocumentSnapshot<AppModelType, DbModelType>
true (prawda), jeśli dokument istnieje.
DocumentSnapshot.get()
Pobiera pole określone przez funkcję fieldPath. Zwraca wartość undefined, jeśli dokument lub pole nie istnieje.
Podpis:
get(fieldPath: string | FieldPath): any;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| FieldPath | ciąg znaków | FieldPath | Ścieżka (na przykład „foo” lub „foo.bar”) do określonego pola. |
Zwroty:
dowolny
Dane w określonej lokalizacji pola lub nieokreślone, jeśli w dokumencie nie ma takiego pola.