QuerySnapshot class

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

İmza:

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

Özellikler

Mülk Değiştiriciler Tip Tanım
dokümanlar Dizi< SorguBelgesi Anlık Görüntüsü <AppModelType, DbModelType>> QuerySnapshot tüm belgelerin dizisi.
boş boolean QuerySnapshot belge yoksa doğrudur.
meta veri Anlık GörüntüMeta Verileri Bu anlık görüntüye ilişkin, kaynağına ve yerel değişikliklere sahip olup olmadığına ilişkin meta veriler.
sorgu Sorgu <AppModelType, DbModelType> Bu QuerySnapshot almak için get veya onSnapshot çağırdığınız sorgu.
boyut sayı QuerySnapshot Görüntüsü'ndeki belge sayısı.

Yöntemler

Yöntem Değiştiriciler Tanım
docChanges(seçenekler) Son anlık görüntüden bu yana belgedeki değişikliklerin bir dizisini döndürür. Bu ilk anlık görüntü ise, tüm belgeler 'eklenen' değişiklikler olarak listede olacaktır.
forEach(geri arama, thisArg) QuerySnapshot tüm belgeleri numaralandırır.

QuerySnapshot.docs

QuerySnapshot Görüntüsü'ndeki tüm belgelerin dizisi .

İmza:

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

QuerySnapshot.empty

Sorgu QuerySnapshot belge yoksa doğrudur .

İmza:

get empty(): boolean;

QuerySnapshot.metadata

Bu anlık görüntüye ilişkin, kaynağına ve yerel değişikliklere sahip olup olmadığına ilişkin meta veriler.

İmza:

readonly metadata: SnapshotMetadata;

SorguSnapshot.query

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

İmza:

readonly query: Query<AppModelType, DbModelType>;

SorguSnapshot.size

QuerySnapshot Görüntüsü'ndeki belge sayısı .

İmza:

get size(): number;

QuerySnapshot.docChanges()

Son anlık görüntüden bu yana belgedeki değişikliklerin bir dizisini döndürür. Bu ilk anlık görüntü ise, tüm belgeler 'eklenen' değişiklikler olarak listede olacaktır.

İmza:

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

Parametreler

Parametre Tip Tanım
seçenekler Anlık GörüntüDinleme Seçenekleri Yalnızca meta veri değişikliklerinin (yani yalnızca DocumentSnapshot.metadata değişikliğinin) anlık görüntü olaylarını tetikleyip tetiklemeyeceğini kontrol eden SnapshotListenOptions .

İadeler:

Dizi< DocumentChange <AppModelType, DbModelType>>

QuerySnapshot.forEach()

QuerySnapshot Görüntüsü'ndeki tüm belgeleri numaralandırır .

İmza:

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

Parametreler

Parametre Tip Tanım
geri çağırmak (sonuç: QueryDocumentSnapshot <AppModelType, DbModelType>) => geçersiz Anlık görüntüdeki her belge için QueryDocumentSnapshot ile çağrılacak bir geri arama.
buArg Bilinmeyen Geri arama için this bağlayıcılık.

İadeler:

geçersiz