DocumentSnapshot class

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.
meta veriler SnapshotMetadata Kaynağı ve yerel değişiklikleri de dahil olmak üzere DocumentSnapshot ile ilgili meta veriler.
başvuru DocumentReference<AppModelType, DbModelType> DocumentSnapshot içinde yer alan doküman için DocumentReference.

Yöntemler

Yöntem Değiştiriciler Açıklama
data(seçenekler) Belgedeki tüm alanları Object biçiminde alır. Doküman yoksa undefined değerini döndürür.Varsayılan olarak, henüz nihai değerine ayarlanmamış serverTimestamp() değerleri null olarak döndürülür. Bir seçenekler nesnesi ileterek bunu geçersiz kılabilirsiniz.
exists() Verilerin mevcut olup olmadığını döndürür. Doküman varsa doğru değerini alır.
get(fieldPath, options) fieldPath tarafından belirtilen alanı alır. Doküman veya alan mevcut değilse undefined değerini döndürür.Varsayılan olarak, nihai değeri henüz ayarlanmamış bir serverTimestamp() null olarak döndürülür. Bir seçenekler nesnesi ileterek bunu geçersiz kılabilirsiniz.

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.metadata

Kaynağı ve yerel değişiklikleri de dahil olmak üzere DocumentSnapshot ile ilgili meta veriler.

İmza:

readonly metadata: SnapshotMetadata;

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.

Varsayılan olarak, henüz nihai değerine ayarlanmamış serverTimestamp() değerleri null olarak döndürülür. Bir seçenekler nesnesi ileterek bunu geçersiz kılabilirsiniz.

İmza:

data(options?: SnapshotOptions): AppModelType | undefined;

Parametreler

Parametre Tür Açıklama
seçenekler SnapshotOptions Verilerin anlık görüntüden nasıl alınacağını belirleyen bir options nesnesi (örneğin, henüz son değerlerine ayarlanmamış sunucu zaman damgaları için istenen davranış).

Şunu döndürür:

AppModelType | tanımsız

Belgedeki tüm alanları içeren Object veya doküman yoksa undefined.

DocumentSnapshot.exists()

Verilerin mevcut olup olmadığını döndürür. Doküman varsa doğru değerini alır.

İmza:

exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;

Şunu döndürür:

Bu: QueryDocumentSnapshot<AppModelType, DbModelType>

DocumentSnapshot.get()

fieldPath tarafından belirtilen alanı alır. Doküman veya alan yoksa undefined değerini döndürür.

Varsayılan olarak, henüz nihai değerine ayarlanmamış bir serverTimestamp() null olarak döndürülür. Bir seçenekler nesnesi ileterek bunu geçersiz kılabilirsiniz.

İmza:

get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;

Parametreler

Parametre Tür Açıklama
FieldPath dize | FieldPath Belirli bir alanın yolu (ör. "foo" veya "foo.bar").
seçenekler SnapshotOptions Alanın anlık görüntüden nasıl alınacağını yapılandıran bir options nesnesi (örneğin, henüz son değerlerine ayarlanmamış sunucu zaman damgaları için istenen davranış).

Şunu döndürür:

herhangi bir

Belirtilen alan konumundaki veriler veya dokümanda böyle bir alan yoksa tanımlanmamış.