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. |
|
| metadane, | SnapshotMetadata | Metadane dotyczące obiektu DocumentSnapshot, w tym informacje o jego źródle i lokalnych modyfikacjach. |
|
| źródło | DocumentReference<AppModelType, DbModelType> | Pole DocumentReference dokumentu uwzględnione w pliku DocumentSnapshot. |
Metody
| Metoda | Modyfikatory | Opis |
|---|---|---|
| dane(opcje) | Pobiera wszystkie pola w dokumencie jako Object. Zwraca undefined, jeśli dokument nie istnieje.Domyślnie serverTimestamp() wartości, które nie mają jeszcze ustawionej ostatecznej wartości, są zwracane jako null. Możesz zastąpić to ustawienie, przekazując obiekt opcji. |
|
| exists() | Wskazuje, czy dane istnieją, czy nie. Prawda, jeśli dokument istnieje. | |
| get(fieldPath, opcje) | Pobiera pole określone przez funkcję fieldPath. Zwraca wartość undefined, jeśli dokument lub pole nie istnieje.Domyślnie element serverTimestamp(), który nie ma jeszcze ostatecznej wartości, zostanie zwrócony jako null. Możesz zastąpić to ustawienie, przekazując obiekt opcji. |
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.metadata
Metadane dotyczące obiektu DocumentSnapshot, w tym informacje o jego źródle i lokalnych modyfikacjach.
Podpis:
readonly metadata: SnapshotMetadata;
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.
Domyślnie wartość końcowa parametru serverTimestamp(), która nie została ustawiona, jest zwracana jako null. Możesz zastąpić to ustawienie, przekazując obiekt opcji.
Podpis:
data(options?: SnapshotOptions): AppModelType | undefined;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| opcje | SnapshotOptions (Opcje zrzutu) | Obiekt opcji służący do konfigurowania sposobu pobierania danych ze zrzutu (np. oczekiwanego zachowania w przypadku sygnatur czasowych serwera, które nie zostały jeszcze ustawione na ostateczną wartość). |
Zwroty:
AppModelType | nie zdefiniowano
Pole Object zawierające wszystkie pola w dokumencie lub undefined, jeśli dokument nie istnieje.
DocumentSnapshot.exists()
Wskazuje, czy dane istnieją, czy nie. Prawda, jeśli dokument istnieje.
Podpis:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
Zwroty:
to QueryDocumentSnapshot<AppModelType, DbModelType>
DocumentSnapshot.get()
Pobiera pole określone przez funkcję fieldPath. Zwraca wartość undefined, jeśli dokument lub pole nie istnieje.
Domyślnie wartość serverTimestamp(), dla której nie ustawiono jeszcze ostatecznej wartości, jest zwracana jako null. Możesz zastąpić to ustawienie, przekazując obiekt opcji.
Podpis:
get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| FieldPath | ciąg znaków | FieldPath | Ścieżka (na przykład „foo” lub „foo.bar”) do określonego pola. |
| opcje | SnapshotOptions (Opcje zrzutu) | Obiekt opcji służący do konfigurowania sposobu pobierania pola ze zrzutu (np. oczekiwanego zachowania w przypadku sygnatur czasowych serwera, które nie zostały jeszcze ustawione na ostateczną wartość). |
Zwroty:
dowolny
Dane w określonej lokalizacji pola lub nieokreślone, jeśli w dokumencie nie ma takiego pola.