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;

حدود

عائدات:

نوع نموذج التطبيق | غير معرف

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;

حدود

عائدات:

أي

البيانات الموجودة في موقع الحقل المحدد أو غير محددة في حالة عدم وجود مثل هذا الحقل في المستند.