يحتوي QueryDocumentSnapshot على بيانات تمت قراءتها من مستند في قاعدة بيانات Firestore كجزء من الاستعلام. الوثيقة مضمونة الوجود ويمكن استخراج بياناتها باستخدام .data() أو .get(<field>) للحصول على حقل معين.
يقدم QueryDocumentSnapshot نفس سطح واجهة برمجة التطبيقات (API) مثل DocumentSnapshot . نظرًا لأن نتائج الاستعلام تحتوي على مستندات موجودة فقط، فستكون الخاصية exists دائمًا صحيحة ولن تُرجع data() أبدًا القيمة "غير محددة".
إمضاء:
export declare class QueryDocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends DocumentSnapshot<AppModelType, DbModelType>
يمتد: DocumentSnapshot <AppModelType، DbModelType>
طُرق
| طريقة | الصفات التعريفية | وصف |
|---|---|---|
| البيانات (الخيارات) | يسترد كافة الحقول في المستند Object . افتراضيًا، سيتم إرجاع قيم serverTimestamp() التي لم يتم تعيينها بعد إلى قيمتها النهائية على أنها null . يمكنك تجاوز هذا عن طريق تمرير كائن الخيارات. |
QueryDocumentSnapshot.data()
يسترد كافة الحقول في المستند Object .
افتراضيًا، سيتم إرجاع قيم serverTimestamp() التي لم يتم تعيينها بعد إلى قيمتها النهائية باعتبارها null . يمكنك تجاوز هذا عن طريق تمرير كائن الخيارات.
إمضاء:
/** @override */
data(options?: SnapshotOptions): AppModelType;
حدود
| معامل | يكتب | وصف |
|---|---|---|
| خيارات | خيارات اللقطة | كائن خيارات لتكوين كيفية استرداد البيانات من اللقطة (على سبيل المثال، السلوك المطلوب للطوابع الزمنية للخادم التي لم يتم تعيينها بعد على قيمتها النهائية). |
عائدات:
AppModelType
Object يحتوي على كافة الحقول في المستند.