QuerySnapshot class

یک QuerySnapshot حاوی صفر یا چند شیء DocumentSnapshot است که نتایج یک پرس و جو را نشان می دهد. اسناد را می توان به عنوان یک آرایه از طریق ویژگی docs یا با استفاده از روش forEach شمارش کرد. تعداد اسناد را می توان از طریق خصوصیات empty و size تعیین کرد.

امضا:

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

خواص

مواد و روش ها

QuerySnapshot.docs

آرایه ای از تمام اسناد موجود در QuerySnapshot .

امضا:

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

QuerySnapshot.empty

اگر هیچ سندی در QuerySnapshot وجود نداشته باشد درست است .

امضا:

get empty(): boolean;

QuerySnapshot.metadata

فراداده مربوط به این عکس فوری، مربوط به منبع آن و اینکه آیا تغییرات محلی دارد.

امضا:

readonly metadata: SnapshotMetadata;

QuerySnapshot.query

درخواستی که برای دریافت این QuerySnapshot get یا onSnapshot فراخوانی کردید .

امضا:

readonly query: Query<AppModelType, DbModelType>;

QuerySnapshot.size

تعداد اسناد در QuerySnapshot .

امضا:

get size(): number;

QuerySnapshot.docChanges()

آرایه ای از اسناد تغییر یافته از آخرین عکس فوری را برمی گرداند. اگر این اولین عکس فوری باشد، همه اسناد به عنوان تغییرات "افزوده شده" در لیست قرار خواهند گرفت.

امضا:

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

مولفه های

برمی گرداند:

Array< DocumentChange <AppModelType، DbModelType>>

QuerySnapshot.forEach()

تمام اسناد موجود در QuerySnapshot را بر می شمارد .

امضا:

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

مولفه های

برمی گرداند:

خالی