תמונת DocumentSnapshot מכילה נתונים שנקראו ממסמך במסד הנתונים של Firestore. ניתן לחלץ את הנתונים עם .data() או .get(<field>) כדי לקבל שדה ספציפי.
עבור DocumentSnapshot המצביע על מסמך לא קיים, כל גישה לנתונים תחזיר 'לא מוגדר'. אתה יכול להשתמש בשיטת exists() כדי לאמת במפורש את קיומו של מסמך.
חֲתִימָה:
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
בונים
| בַּנַאִי | משנה | תיאור |
|---|---|---|
| (בַּנַאִי)() | בונה מופע חדש של המחלקה DocumentSnapshot |
נכסים
| תכונה | משנה | סוּג | תיאור |
|---|---|---|---|
| תְעוּדַת זֶהוּת | חוּט | מאפיין של DocumentSnapshot המספק את מזהה המסמך. | |
| ref | הפניה למסמך <AppModelType, DbModelType> | ה- DocumentReference עבור המסמך הכלול ב- DocumentSnapshot . |
שיטות
| שיטה | משנה | תיאור |
|---|---|---|
| נתונים() | מאחזר את כל השדות במסמך Object . מחזירה undefined אם המסמך לא קיים. | |
| קיים() | מסמן אם המסמך במיקום תמונת המצב קיים או לא. | |
| get(fieldPath) | מאחזר את השדה שצוין על ידי fieldPath . מחזירה undefined אם המסמך או השדה אינם קיימים. |
DocumentSnapshot.(קונסטרוקטור)
בונה מופע חדש של המחלקה DocumentSnapshot
חֲתִימָה:
protected constructor();
DocumentSnapshot.id
מאפיין של DocumentSnapshot המספק את מזהה המסמך.
חֲתִימָה:
get id(): string;
DocumentSnapshot.ref
ה- DocumentReference עבור המסמך הכלול ב- DocumentSnapshot .
חֲתִימָה:
get ref(): DocumentReference<AppModelType, DbModelType>;
DocumentSnapshot.data()
מאחזר את כל השדות במסמך Object . מחזירה undefined אם המסמך לא קיים.
חֲתִימָה:
data(): AppModelType | undefined;
החזרות:
AppModelType | לא מוגדר
Object המכיל את כל השדות במסמך או undefined אם המסמך אינו קיים.
DocumentSnapshot.exists()
מסמן אם המסמך במיקום תמונת המצב קיים או לא.
חֲתִימָה:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
החזרות:
זהו QueryDocumentSnapshot <AppModelType, DbModelType>
נכון אם המסמך קיים.
DocumentSnapshot.get()
מאחזר את השדה שצוין על ידי fieldPath . מחזירה undefined אם המסמך או השדה אינם קיימים.
חֲתִימָה:
get(fieldPath: string | FieldPath): any;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| fieldPath | מחרוזת | FieldPath | הנתיב (לדוגמה 'foo' או 'foo.bar') לשדה ספציפי. |
החזרות:
כל
הנתונים במיקום השדה שצוין או לא מוגדר אם לא קיים שדה כזה במסמך.