QuerySnapshot class

QuerySnapshot öğesi, sorgunun sonuçlarını temsil eden sıfır veya daha fazla DocumentSnapshot nesnesi içerir. Dokümanlara docs özelliği aracılığıyla dizi olarak erişilebilir veya forEach yöntemi kullanılarak numaralandırılabilir. Doküman sayısı, empty ve size özellikleri aracılığıyla belirlenebilir.

İmza:

export declare class QuerySnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>

Özellikler

Özellik Değiştiriciler Tür Açıklama
dokümanlar Dizi<QueryDocumentSnapshot<AppModelType, DbModelType>> QuerySnapshot içindeki tüm belgelerin yer aldığı dizi.
boş boolean QuerySnapshot içinde belge yoksa doğru değerini döndürür.
meta veriler SnapshotMetadata Bu anlık görüntüyle ilgili, kaynağı ve yerel değişiklikler olup olmadığı hakkındaki meta veriler.
sorgu Sorgu<AppModelType, DbModelType> QuerySnapshot öğesini almak için get veya onSnapshot adını çağırdığınız sorgu.
size [beden] sayı QuerySnapshot öğesindeki doküman sayısı.

Yöntemler

Yöntem Değiştiriciler Açıklama
docChanges(options) Son anlık görüntüden bu yana belge değişikliklerinin bir dizisini döndürür. Bu ilk anlık görüntüyse, tüm dokümanlar listede "eklendi" olarak yer alır. anlamına gelir.
forEvery(callback, thisArg) QuerySnapshot içindeki tüm dokümanları numaralandırır.

QuerySnapshot.docs

QuerySnapshot alanındaki tüm belgelerin yer aldığı bir dizi.

İmza:

get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;

QuerySnapshot.boş

QuerySnapshot içinde belge yoksa doğru değerini döndürür.

İmza:

get empty(): boolean;

QuerySnapshot.metadata

Bu anlık görüntüyle ilgili, kaynağı ve yerel değişiklikler olup olmadığı hakkındaki meta veriler.

İmza:

readonly metadata: SnapshotMetadata;

QuerySnapshot.query

Bu QuerySnapshot öğesini almak için get veya onSnapshot yöntemini çağırdığınız sorgu.

İmza:

readonly query: Query<AppModelType, DbModelType>;

QuerySnapshot.size

QuerySnapshot kapsamındaki dokümanların sayısı.

İmza:

get size(): number;

QuerySnapshot.docChanges()

Son anlık görüntüden bu yana belge değişikliklerinin bir dizisini döndürür. Bu ilk anlık görüntüyse, tüm dokümanlar listede "eklendi" olarak yer alır. anlamına gelir.

İmza:

docChanges(options?: SnapshotListenOptions): Array<DocumentChange<AppModelType, DbModelType>>;

Parametreler

Parametre Tür Açıklama
seçenekler SnapshotListenOptions Yalnızca meta veri değişikliklerinin (ör. yalnızca DocumentSnapshot.metadata değişikliklerinin) anlık görüntü etkinliklerini tetikleyip tetiklemeyeceğini kontrol eden SnapshotListenOptions.

Şunu döndürür:

Dizi<DocumentChange<AppModelType, DbModelType>>

QuerySnapshot.forEvery()

QuerySnapshot içindeki tüm belgeleri belirtir.

İmza:

forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;

Parametreler

Parametre Tür Açıklama
geri çağırma (sonuç: QueryDocumentSnapshot<AppModelType, DbModelType>) => geçersiz Anlık görüntüdeki her belge için QueryDocumentSnapshot ile çağrılacak bir geri çağırma.
buArg bilinmiyor Geri çağırma için this bağlaması.

Şunu döndürür:

geçersiz