QueryDocumentSnapshot
حاوی داده هایی است که از یک سند در پایگاه داده Firestore شما به عنوان بخشی از یک پرس و جو خوانده می شود. وجود سند تضمین شده است و داده های آن را می توان با .data()
یا .get(<field>)
استخراج کرد تا یک فیلد خاص به دست آید.
یک QueryDocumentSnapshot
همان سطح API را به عنوان DocumentSnapshot
ارائه می دهد . از آنجایی که نتایج پرس و جو فقط حاوی اسناد موجود هستند، ویژگی exists
همیشه true خواهد بود و data()
هرگز 'undefined' برنمیگرداند.
امضا:
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;
مولفه های
پارامتر | تایپ کنید | شرح |
---|---|---|
گزینه ها | SnapshotOptions | یک گزینه برای پیکربندی نحوه بازیابی داده ها از عکس فوری (مثلاً رفتار مورد نظر برای مُهرهای زمانی سرور که هنوز روی مقدار نهایی خود تنظیم نشده اند) شیء است. |
برمی گرداند:
AppModelType
یک Object
حاوی تمام فیلدهای سند.