يحتوي QuerySnapshot
على صفر أو أكثر من كائنات DocumentSnapshot
التي تمثل نتائج الاستعلام. يمكن الوصول إلى المستندات كمصفوفة عبر خاصية docs
أو تعدادها باستخدام طريقة forEach
. يمكن تحديد عدد المستندات من خلال الخصائص empty
size
.
إمضاء:
export declare class QuerySnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
ملكيات
ملكية | الصفات التعريفية | يكتب | وصف |
---|---|---|---|
مستندات | صفيف< QueryDocumentSnapshot <AppModelType، DbModelType>> | مجموعة من كافة المستندات الموجودة في QuerySnapshot . | |
فارغ | منطقية | صحيح إذا لم تكن هناك مستندات في QuerySnapshot . | |
البيانات الوصفية | SnapshotMetadata | البيانات الوصفية حول هذه اللقطة، فيما يتعلق بمصدرها وما إذا كانت تحتوي على تعديلات محلية. | |
استفسار | استفسار <AppModelType، DbModelType> | الاستعلام الذي اتصلت به get أو onSnapshot للحصول على QuerySnapshot هذا. | |
مقاس | رقم | عدد المستندات في QuerySnapshot . |
طُرق
طريقة | الصفات التعريفية | وصف |
---|---|---|
مستند التغييرات (الخيارات) | إرجاع مجموعة من التغييرات في المستندات منذ اللقطة الأخيرة. إذا كانت هذه هي اللقطة الأولى، فستكون جميع المستندات في القائمة كتغييرات "مضافة". | |
forEch (رد الاتصال، thisArg) | تعداد كافة المستندات الموجودة في QuerySnapshot . |
QuerySnapshot.docs
مجموعة من جميع المستندات الموجودة في QuerySnapshot
.
إمضاء:
get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;
QuerySnapshot.empty
صحيح إذا لم تكن هناك مستندات في QuerySnapshot
.
إمضاء:
get empty(): boolean;
QuerySnapshot.metadata
البيانات الوصفية حول هذه اللقطة، فيما يتعلق بمصدرها وما إذا كانت تحتوي على تعديلات محلية.
إمضاء:
readonly metadata: SnapshotMetadata;
QuerySnapshot.query
الاستعلام الذي اتصلت به get
أو onSnapshot
للحصول على QuerySnapshot
هذا .
إمضاء:
readonly query: Query<AppModelType, DbModelType>;
QuerySnapshot.size
عدد المستندات في QuerySnapshot
.
إمضاء:
get size(): number;
QuerySnapshot.docChanges()
إرجاع مجموعة من التغييرات في المستندات منذ اللقطة الأخيرة. إذا كانت هذه هي اللقطة الأولى، فستكون جميع المستندات في القائمة كتغييرات "مضافة".
إمضاء:
docChanges(options?: SnapshotListenOptions): Array<DocumentChange<AppModelType, DbModelType>>;
حدود
معامل | يكتب | وصف |
---|---|---|
خيارات | SnapshotListenOptions | SnapshotListenOptions التي تتحكم في ما إذا كانت تغييرات البيانات التعريفية فقط (أي تم تغيير DocumentSnapshot.metadata فقط) يجب أن تؤدي إلى تشغيل أحداث اللقطة. |
عائدات:
صفيف< DocumentChange <AppModelType، DbModelType>>
QuerySnapshot.forEach()
تعداد كافة المستندات الموجودة في QuerySnapshot
.
إمضاء:
forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;
حدود
معامل | يكتب | وصف |
---|---|---|
أتصل مرة أخرى | (النتيجة: QueryDocumentSnapshot <AppModelType, DbModelType>) => باطل | رد اتصال سيتم استدعاؤه باستخدام QueryDocumentSnapshot لكل مستند في اللقطة. |
thisArg | مجهول | this الربط لرد الاتصال. |
عائدات:
فارغ