یک DocumentSnapshot حاوی داده هایی است که از یک سند در پایگاه داده Firestore شما خوانده می شود. داده ها را می توان با .data() یا .get(<field>) استخراج کرد تا یک فیلد خاص به دست آید.
برای یک DocumentSnapshot که به یک سند غیرموجود اشاره می‌کند، هر گونه دسترسی به داده به صورت «تعریف نشده» برمی‌گردد. شما می توانید از متد exists() برای تایید صریح وجود یک سند استفاده کنید.
امضا:
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
سازندگان
| سازنده | اصلاح کننده ها | شرح |
|---|---|---|
| (سازنده)() | یک نمونه جدید از کلاس DocumentSnapshot می سازد |
خواص
| ویژگی | اصلاح کننده ها | تایپ کنید | شرح |
|---|---|---|---|
| شناسه | رشته | ویژگی DocumentSnapshot که شناسه سند را ارائه می کند. | |
| فراداده | Snapshot Metadata | فراداده درباره DocumentSnapshot ، از جمله اطلاعات مربوط به منبع و تغییرات محلی آن. | |
| مرجع | مرجع سند <AppModelType، DbModelType> | DocumentReference برای سند موجود در DocumentSnapshot . |
مواد و روش ها
| روش | اصلاح کننده ها | شرح |
|---|---|---|
| داده ها (گزینه ها) | همه فیلدهای سند را به عنوان یک Object بازیابی می کند. اگر سند وجود نداشته باشد undefined برمی گردد. به‌طور پیش‌فرض، مقادیر serverTimestamp() که هنوز روی مقدار نهایی خود تنظیم نشده‌اند به‌عنوان null برگردانده می‌شوند. شما می توانید با ارسال یک شی گزینه، این مورد را لغو کنید. | |
| وجود دارد() | وجود یا عدم وجود داده را برمی‌گرداند. در صورت وجود سند صحیح است. | |
| get (fieldPath، گزینه‌ها) | فیلد مشخص شده توسط fieldPath را بازیابی می کند. اگر سند یا فیلد وجود نداشته باشد undefined برمی گردد. به‌طور پیش‌فرض، یک serverTimestamp() که هنوز به مقدار نهایی خود تنظیم نشده است به عنوان null برگردانده می‌شود. شما می توانید با ارسال یک شی گزینه، این مورد را لغو کنید. |
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;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| گزینه ها | SnapshotOptions | یک گزینه برای پیکربندی نحوه بازیابی داده ها از عکس فوری (مثلاً رفتار مورد نظر برای مُهرهای زمانی سرور که هنوز روی مقدار نهایی خود تنظیم نشده اند) شیء است. |
برمی‌گرداند:
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;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| fieldPath | رشته | FieldPath | مسیر (به عنوان مثال 'foo' یا 'foo.bar') به یک فیلد خاص. |
| گزینه ها | SnapshotOptions | یک گزینه برای پیکربندی نحوه بازیابی فیلد از عکس فوری (مثلاً رفتار مورد نظر برای مُهرهای زمانی سرور که هنوز روی مقدار نهایی خود تنظیم نشده اند) شیء است. |
برمی‌گرداند:
هر
داده ها در محل فیلد مشخص شده یا تعریف نشده در صورت عدم وجود چنین فیلدی در سند.