QuerySnapshot class

يحتوي QuerySnapshot على صفر أو أكثر من عناصر DocumentSnapshot التي تمثّل نتائج طلب بحث. يمكن الوصول إلى المستندات كمصفوفة من خلال السمة docs أو تعدادها باستخدام الطريقة forEach. يمكن تحديد عدد المستندات من خلال السمتَين empty وsize.

Signature:

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

أماكن إقامة

الموقع	المعدِّلات	النوع	الوصف
مستندات		المصفوفة<QueryDocumentSnapshot<AppModelType, DbModelType>>	مصفوفة تضم جميع المستندات في QuerySnapshot.
فارغة		قيمة منطقية	صحيح إذا لم تتوفر مستندات في QuerySnapshot.
البيانات الوصفية		SnapshotMetadata	البيانات الوصفية المتعلّقة بهذه اللقطة في ما يتعلّق بمصدرها وما إذا كانت تحتوي على تعديلات محلية
طلب البحث		طلب البحث<AppModelType, DbModelType>	الاستعلام الذي اتصلت عليه بـ get أو onSnapshot للحصول على QuerySnapshot هذا.
size (المقاس)		رقم	عدد المستندات في QuerySnapshot.

الطُرق

الطريقة	المعدِّلات	الوصف
docChanges(options)		لعرض مصفوفة من التغييرات التي تم إجراؤها على المستندات منذ آخر لقطة. إذا كانت هذه هي اللقطة الأولى، فستكون جميع المستندات في القائمة باعتبارها "مضافة". التغييرات.
for each(callback, thisArg)		لتعداد جميع المستندات في QuerySnapshot.

QuerySnapshot.docs

مصفوفة تضمّ جميع المستندات في QuerySnapshot

Signature:

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

صورة QuerySnapshot فارغة

صحيح إذا لم تتوفّر مستندات في QuerySnapshot.

Signature:

get empty(): boolean;

QuerySnapshot.metadata

البيانات الوصفية المتعلّقة بهذه اللقطة في ما يتعلّق بمصدرها وما إذا كانت تحتوي على تعديلات محلية

Signature:

readonly metadata: SnapshotMetadata;

طلب البحث QuerySnapshot

طلب البحث الذي اتصلت عليه بـ get أو onSnapshot للحصول على QuerySnapshot.

Signature:

readonly query: Query<AppModelType, DbModelType>;

حجم QuerySnapshot

عدد المستندات في QuerySnapshot

Signature:

get size(): number;

QuerySnapshot.docChanges()

لعرض مصفوفة من التغييرات التي تم إجراؤها على المستندات منذ آخر لقطة. إذا كانت هذه هي اللقطة الأولى، فستكون جميع المستندات في القائمة باعتبارها "مضافة". التغييرات.

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
خيارات	SnapshotListenOptions	SnapshotListenOptions التي تتحكّم في ما إذا كانت التغييرات في البيانات الوصفية فقط (أي تم تغيير DocumentSnapshot.metadata فقط) يجب أن تؤدي إلى تشغيل أحداث اللقطة.

المرتجعات:

المصفوفة<DocumentChange<AppModelType, DbModelType>>

QuerySnapshot.for المنسدلة()

لتعداد جميع المستندات في QuerySnapshot.

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
رد الاتصال	(النتيجة: QueryDocumentSnapshot<AppModelType, DbModelType>) => فراغ	نوع معاودة الاتصال الذي سيتم طلبه باستخدام QueryDocumentSnapshot لكل مستند في اللقطة.
هذا المتوسط	غير معروف	تمثّل هذه السمة ربط this لمعاودة الاتصال.

المرتجعات:

فراغ