یک DocumentSnapshot حاوی داده هایی است که از یک سند در پایگاه داده Firestore شما خوانده می شود. داده ها را می توان با .data() یا .get(<field>) استخراج کرد تا یک فیلد خاص به دست آید.
برای یک DocumentSnapshot که به یک سند غیرموجود اشاره می‌کند، هر گونه دسترسی به داده به صورت «تعریف نشده» برمی‌گردد. شما می توانید از متد exists() برای تایید صریح وجود یک سند استفاده کنید.
امضا:
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
سازندگان
| سازنده | اصلاح کننده ها | شرح |
|---|---|---|
| (سازنده)() | یک نمونه جدید از کلاس DocumentSnapshot می سازد |
خواص
| ویژگی | اصلاح کننده ها | تایپ کنید | شرح |
|---|---|---|---|
| شناسه | رشته | ویژگی DocumentSnapshot که شناسه سند را ارائه می کند. | |
| مرجع | مرجع سند <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') به یک فیلد خاص. |
برمی گرداند:
هر
داده ها در محل فیلد مشخص شده یا تعریف نشده در صورت عدم وجود چنین فیلدی در سند.