DocumentSnapshot, Firestore veritabanınızdaki bir belgeden okunan verileri içerir. Belirli bir alanı almak için veriler .data() veya .get(<field>) ile çıkarılabilir.
Mevcut olmayan bir dokümana işaret eden DocumentSnapshot için tüm veri erişimleri "tanımsız" değerini döndürecektir. Bir dokümanın varlığını açıkça doğrulamak için exists() yöntemini kullanabilirsiniz.
İmza:
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Markalar
| Marka | Değiştiriciler | Açıklama |
|---|---|---|
| (buildor)() | DocumentSnapshot sınıfının yeni bir örneğini oluşturur |
Özellikler
| Özellik | Değiştiriciler | Tür | Açıklama |
|---|---|---|---|
| id | dize | Dokümanın kimliğini sağlayan DocumentSnapshot özelliği. |
|
| başvuru | DocumentReference<AppModelType, DbModelType> | DocumentSnapshot içinde yer alan doküman için DocumentReference. |
Yöntemler
| Yöntem | Değiştiriciler | Açıklama |
|---|---|---|
| veri() | Belgedeki tüm alanları Object biçiminde alır. Belge mevcut değilse undefined değerini döndürür. |
|
| exists() | Belgenin anlık görüntünün konumunda mevcut olup olmadığını belirtir. | |
| get(fieldPath) | fieldPath tarafından belirtilen alanı alır. Doküman veya alan yoksa undefined değerini döndürür. |
DocumentSnapshot.(oluşturucu)
DocumentSnapshot sınıfının yeni bir örneğini oluşturur
İmza:
protected constructor();
DocumentSnapshot.id
Dokümanın kimliğini sağlayan DocumentSnapshot özelliği.
İmza:
get id(): string;
DocumentSnapshot.ref
DocumentSnapshot dokümanında yer alan doküman için DocumentReference.
İmza:
get ref(): DocumentReference<AppModelType, DbModelType>;
DocumentSnapshot.data()
Belgedeki tüm alanları Object olarak alır. Belge mevcut değilse undefined değerini döndürür.
İmza:
data(): AppModelType | undefined;
Şunu döndürür:
AppModelType | tanımsız
Belgedeki tüm alanları içeren Object veya doküman yoksa undefined.
DocumentSnapshot.exists()
Belgenin anlık görüntünün konumunda mevcut olup olmadığını belirtir.
İmza:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
Şunu döndürür:
Bu: QueryDocumentSnapshot<AppModelType, DbModelType>
true (doğru) değerini alır.
DocumentSnapshot.get()
fieldPath tarafından belirtilen alanı alır. Doküman veya alan yoksa undefined değerini döndürür.
İmza:
get(fieldPath: string | FieldPath): any;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| alanYolu | dize | FieldPath | Belirli bir alanın yolu (ör. "foo" veya "foo.bar"). |
Şunu döndürür:
herhangi bir
Belirtilen alan konumundaki veriler veya dokümanda böyle bir alan yoksa tanımlanmamış.