DocumentSnapshot class

DocumentSnapshot आपके फायरस्टोर डेटाबेस में किसी दस्तावेज़ से पढ़ा गया डेटा शामिल होता है। विशिष्ट फ़ील्ड प्राप्त करने के लिए डेटा को .data() या .get(<field>) से निकाला जा सकता है।

किसी ऐसे DocumentSnapshot के लिए जो किसी गैर-मौजूदा दस्तावेज़ को इंगित करता है, कोई भी डेटा एक्सेस 'अपरिभाषित' लौटाएगा। किसी दस्तावेज़ के अस्तित्व को स्पष्ट रूप से सत्यापित करने के लिए आप exists() विधि का उपयोग कर सकते हैं।

हस्ताक्षर:

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

कंस्ट्रक्टर्स

निर्माता	संशोधक	विवरण
(निर्माता)()		DocumentSnapshot वर्ग का एक नया उदाहरण बनाता है

गुण

संपत्ति	संशोधक	प्रकार	विवरण
पहचान		डोरी	DocumentSnapshot की संपत्ति जो दस्तावेज़ की आईडी प्रदान करती है।
मेटाडाटा		स्नैपशॉटमेटाडेटा	DocumentSnapshot के बारे में मेटाडेटा, जिसमें इसके स्रोत और स्थानीय संशोधनों के बारे में जानकारी शामिल है।
संदर्भ		दस्तावेज़संदर्भ <AppModelType, DbModelType>	दस्तावेज़ के लिए DocumentReference DocumentSnapshot में शामिल है।

तरीकों

तरीका	संशोधक	विवरण
डेटा(विकल्प)		दस्तावेज़ में सभी फ़ील्ड को Object के रूप में पुनर्प्राप्त करता है। यदि दस्तावेज़ मौजूद नहीं है तो undefined लौटाता है। डिफ़ॉल्ट रूप से, serverTimestamp() मान जो अभी तक उनके अंतिम मान पर सेट नहीं किए गए हैं, उन्हें null के रूप में लौटाया जाएगा। आप विकल्प ऑब्जेक्ट पास करके इसे ओवरराइड कर सकते हैं।
मौजूद()		यह बताता है कि डेटा मौजूद है या नहीं। यदि दस्तावेज़ मौजूद है तो सत्य है।
प्राप्त करें (फ़ील्डपाथ, विकल्प)		fieldPath द्वारा निर्दिष्ट फ़ील्ड पुनर्प्राप्त करता है। यदि दस्तावेज़ या फ़ील्ड मौजूद नहीं है तो undefined लौटाता है। डिफ़ॉल्ट रूप से, एक serverTimestamp() जो अभी तक अपने अंतिम मान पर सेट नहीं किया गया है, उसे null के रूप में लौटाया जाएगा। आप विकल्प ऑब्जेक्ट पास करके इसे ओवरराइड कर सकते हैं।

दस्तावेज़स्नैपशॉट.(निर्माता)

DocumentSnapshot वर्ग का एक नया उदाहरण बनाता है

हस्ताक्षर:

protected constructor();

DocumentSnapshot.id

DocumentSnapshot की संपत्ति जो दस्तावेज़ की आईडी प्रदान करती है।

हस्ताक्षर:

get id(): string;

दस्तावेज़स्नैपशॉट.मेटाडेटा

DocumentSnapshot के बारे में मेटाडेटा , जिसमें इसके स्रोत और स्थानीय संशोधनों के बारे में जानकारी शामिल है।

हस्ताक्षर:

readonly metadata: SnapshotMetadata;

दस्तावेज़स्नैपशॉट.रेफ

दस्तावेज़ के लिए DocumentReference DocumentSnapshot में शामिल है .

हस्ताक्षर:

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

दस्तावेज़स्नैपशॉट.डेटा()

दस्तावेज़ में सभी फ़ील्ड को Object के रूप में पुनर्प्राप्त करता है . यदि दस्तावेज़ मौजूद नहीं है तो undefined लौटाता है।

डिफ़ॉल्ट रूप से, serverTimestamp() मान जो अभी तक उनके अंतिम मान पर सेट नहीं किए गए हैं, उन्हें null के रूप में लौटाया जाएगा . आप विकल्प ऑब्जेक्ट पास करके इसे ओवरराइड कर सकते हैं।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	प्रकार	विवरण
विकल्प	स्नैपशॉट विकल्प	स्नैपशॉट से डेटा कैसे पुनर्प्राप्त किया जाता है, इसे कॉन्फ़िगर करने के लिए एक विकल्प ऑब्जेक्ट (उदाहरण के लिए सर्वर टाइमस्टैम्प के लिए वांछित व्यवहार जो अभी तक उनके अंतिम मान पर सेट नहीं किया गया है)।

रिटर्न:

ऐपमॉडलटाइप | अपरिभाषित

एक Object जिसमें दस्तावेज़ में सभी फ़ील्ड शामिल हैं या यदि दस्तावेज़ मौजूद नहीं है तो undefined ।

दस्तावेज़स्नैपशॉट.मौजूद()

यह बताता है कि डेटा मौजूद है या नहीं। यदि दस्तावेज़ मौजूद है तो सत्य है।

हस्ताक्षर:

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

रिटर्न:

यह QueryDocumentSnapshot है <AppModelType, DbModelType>

दस्तावेज़स्नैपशॉट.प्राप्त()

fieldPath द्वारा निर्दिष्ट फ़ील्ड पुनर्प्राप्त करता है . यदि दस्तावेज़ या फ़ील्ड मौजूद नहीं है तो undefined लौटाता है।

डिफ़ॉल्ट रूप से, एक serverTimestamp() जो अभी तक अपने अंतिम मान पर सेट नहीं किया गया है, उसे null के रूप में लौटाया जाएगा . आप विकल्प ऑब्जेक्ट पास करके इसे ओवरराइड कर सकते हैं।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	प्रकार	विवरण
फ़ील्डपथ	स्ट्रिंग | फ़ील्डपथ	किसी विशिष्ट फ़ील्ड का पथ (उदाहरण के लिए 'foo' या 'foo.bar')।
विकल्प	स्नैपशॉट विकल्प	स्नैपशॉट से फ़ील्ड को कैसे पुनर्प्राप्त किया जाता है, इसे कॉन्फ़िगर करने के लिए एक विकल्प ऑब्जेक्ट (उदाहरण के लिए सर्वर टाइमस्टैम्प के लिए वांछित व्यवहार जो अभी तक उनके अंतिम मान पर सेट नहीं किया गया है)।

रिटर्न:

कोई

निर्दिष्ट फ़ील्ड स्थान पर डेटा या अपरिभाषित यदि दस्तावेज़ में ऐसा कोई फ़ील्ड मौजूद नहीं है।