DocumentSnapshot class

תמונת DocumentSnapshot מכילה נתונים שנקראו ממסמך במסד הנתונים של Firestore. ניתן לחלץ את הנתונים עם .data() או .get(<field>) כדי לקבל שדה ספציפי.

עבור DocumentSnapshot המצביע על מסמך לא קיים, כל גישה לנתונים תחזיר 'לא מוגדר'. אתה יכול להשתמש בשיטת exists() כדי לאמת במפורש את קיומו של מסמך.

חֲתִימָה:

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

בונים

נכסים

שיטות

DocumentSnapshot.(קונסטרוקטור)

בונה מופע חדש של המחלקה DocumentSnapshot

חֲתִימָה:

protected constructor();

DocumentSnapshot.id

מאפיין של DocumentSnapshot המספק את מזהה המסמך.

חֲתִימָה:

get id(): string;

DocumentSnapshot.metadata

מטא נתונים על ה- DocumentSnapshot , כולל מידע על מקורו ושינויים מקומיים.

חֲתִימָה:

readonly metadata: SnapshotMetadata;

DocumentSnapshot.ref

ה- DocumentReference עבור המסמך הכלול ב- DocumentSnapshot .

חֲתִימָה:

get ref(): DocumentReference<AppModelType, DbModelType>;

DocumentSnapshot.data()

מאחזר את כל השדות במסמך Object . מחזירה undefined אם המסמך לא קיים.

כברירת מחדל, ערכי serverTimestamp() שעדיין לא הוגדרו לערך הסופי שלהם יוחזרו כ- null . אתה יכול לעקוף זאת על ידי העברת אובייקט אפשרויות.

חֲתִימָה:

data(options?: SnapshotOptions): AppModelType | undefined;

פרמטרים

החזרות:

AppModelType | לא מוגדר

Object המכיל את כל השדות במסמך או undefined אם המסמך אינו קיים.

DocumentSnapshot.exists()

מחזירה אם הנתונים קיימים או לא. נכון אם המסמך קיים.

חֲתִימָה:

exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;

החזרות:

זהו QueryDocumentSnapshot <AppModelType, DbModelType>

DocumentSnapshot.get()

מאחזר את השדה שצוין על ידי fieldPath . מחזירה undefined אם המסמך או השדה אינם קיימים.

כברירת מחדל, serverTimestamp() שעדיין לא הוגדר לערך הסופי שלו יוחזר כ- null . אתה יכול לעקוף זאת על ידי העברת אובייקט אפשרויות.

חֲתִימָה:

get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;

פרמטרים

החזרות:

כל

הנתונים במיקום השדה שצוין או לא מוגדר אם לא קיים שדה כזה במסמך.