QuerySnapshot class

QuerySnapshot מכיל אפס או יותר אובייקטים DocumentSnapshot המייצגים את התוצאות של שאילתה. ניתן לגשת למסמכים כמערך דרך המאפיין docs או למנות אותם בשיטת forEach . ניתן לקבוע את מספר המסמכים באמצעות המאפיינים empty size .

חֲתִימָה:

export declare class QuerySnapshot

נכסים

תכונה משנה סוּג תיאור
מסמכים מערך< QueryDocumentSnapshot > מערך של כל המסמכים ב- QuerySnapshot .
ריק בוליאני נכון אם אין מסמכים ב- QuerySnapshot .
מטא נתונים SnapshotMetadata מטא נתונים על תמונת מצב זו, בנוגע למקור שלה ואם יש בה שינויים מקומיים.
שאילתא שאילתא השאילתה שעליה קראת get או onSnapshot כדי לקבל את QuerySnapshot הזה.
גודל מספר מספר המסמכים ב- QuerySnapshot .

שיטות

שיטה משנה תיאור
docChanges (אפשרויות) מחזירה מערך של שינויים במסמכים מאז תמונת המצב האחרונה. אם זו תמונת המצב הראשונה, כל המסמכים יהיו ברשימה כשינויים 'נוספים'.
forEach(callback, thisArg) מונה את כל המסמכים ב- QuerySnapshot .

QuerySnapshot.docs

מערך של כל המסמכים ב- QuerySnapshot .

חֲתִימָה:

get docs(): Array>;

QuerySnapshot.empty

נכון אם אין מסמכים ב- QuerySnapshot .

חֲתִימָה:

get empty(): boolean;

QuerySnapshot.metadata

מטא נתונים על תמונת מצב זו, בנוגע למקור שלה ואם יש בה שינויים מקומיים.

חֲתִימָה:

readonly metadata: SnapshotMetadata;

QuerySnapshot.query

השאילתה שבה קראת get או onSnapshot כדי לקבל את ה- QuerySnapshot הזה .

חֲתִימָה:

readonly query: Query;

QuerySnapshot.size

מספר המסמכים ב- QuerySnapshot .

חֲתִימָה:

get size(): number;

QuerySnapshot.docChanges()

מחזירה מערך של שינויים במסמכים מאז תמונת המצב האחרונה. אם זו תמונת המצב הראשונה, כל המסמכים יהיו ברשימה כשינויים 'נוספים'.

חֲתִימָה:

docChanges(options?: SnapshotListenOptions): Array>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפשרויות SnapshotListenOptions SnapshotListenOptions השולטים אם שינויים המבוססים על מטא נתונים בלבד (כלומר רק DocumentSnapshot.metadata השתנו) צריכים להפעיל אירועי תמונת מצב.

החזרות:

מערך< DocumentChange >

QuerySnapshot.forEach()

מונה את כל המסמכים ב- QuerySnapshot .

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
התקשר חזרה (תוצאה: QueryDocumentSnapshot ) => ריק התקשרות חוזרת להתקשרות עם QueryDocumentSnapshot עבור כל מסמך בתמונת המצב.
זה ארג לא ידוע הכריכה this להתקשרות חזרה.

החזרות:

בָּטֵל