یک QuerySnapshot
حاوی صفر یا چند شیء DocumentSnapshot
است که نتایج یک پرس و جو را نشان می دهد. اسناد را می توان به عنوان یک آرایه از طریق ویژگی docs
یا با استفاده از روش forEach
شمارش کرد. تعداد اسناد را می توان از طریق ویژگی های empty
و size
تعیین کرد.
امضا:
export declare class QuerySnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
خواص
ویژگی | اصلاح کننده ها | تایپ کنید | شرح |
---|---|---|---|
اسناد | Array< QueryDocumentSnapshot <AppModelType، DbModelType>> | آرایه ای از تمام اسناد موجود در QuerySnapshot . | |
خالی | بولی | اگر هیچ سندی در QuerySnapshot وجود نداشته باشد درست است. | |
پرس و جو | پرس و جو <AppModelType، DbModelType> | درخواستی که برای دریافت این QuerySnapshot ، getDocs() را فراخوانی کردید. | |
اندازه | عدد | تعداد اسناد در QuerySnapshot . |
مواد و روش ها
روش | اصلاح کننده ها | شرح |
---|---|---|
forEach (پشت به تماس، thisArg) | تمام اسناد موجود در QuerySnapshot را بر می شمارد. |
QuerySnapshot.docs
آرایه ای از تمام اسناد موجود در QuerySnapshot
.
امضا:
get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;
QuerySnapshot.empty
اگر هیچ سندی در QuerySnapshot
وجود نداشته باشد درست است .
امضا:
get empty(): boolean;
QuerySnapshot.query
کوئری که برای دریافت این QuerySnapshot
، getDocs() را فراخوانی کردید .
امضا:
readonly query: Query<AppModelType, DbModelType>;
QuerySnapshot.size
تعداد اسناد در QuerySnapshot
.
امضا:
get size(): number;
QuerySnapshot.forEach()
تمام اسناد موجود در QuerySnapshot
را بر می شمارد .
امضا:
forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;
مولفه های
پارامتر | تایپ کنید | شرح |
---|---|---|
پاسخ به تماس | (نتیجه: QueryDocumentSnapshot <AppModelType، DbModelType>) => خالی است | یک تماس برگشتی برای فراخوانی با QueryDocumentSnapshot برای هر سند در عکس فوری. |
thisArg | ناشناخته | this الزام آور برای پاسخ به تماس. |
برمی گرداند:
خالی