DocumentSnapshot में, आपके Firestore डेटाबेस के किसी दस्तावेज़ से पढ़ा गया डेटा शामिल होता है. किसी खास फ़ील्ड का डेटा पाने के लिए, डेटा को .data() या .get(<field>) की मदद से निकाला जा सकता है.
जो दस्तावेज़ मौजूद नहीं है उस पर ले जाने वाले DocumentSnapshot के लिए, डेटा का कोई भी ऐक्सेस 'तय नहीं है' के तौर पर दिखेगा. किसी दस्तावेज़ की मौजूदगी की साफ़ तौर पर पुष्टि करने के लिए, exists() तरीके का इस्तेमाल किया जा सकता है.
हस्ताक्षर:
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
निर्माता
| निर्माता | मॉडिफ़ायर | ब्यौरा |
|---|---|---|
| (कंस्ट्रक्टर)() | DocumentSnapshot क्लास का एक नया इंस्टेंस बनाता है |
प्रॉपर्टी
| प्रॉपर्टी | मॉडिफ़ायर | टाइप | ब्यौरा |
|---|---|---|---|
| id | स्ट्रिंग | DocumentSnapshot की प्रॉपर्टी, जो दस्तावेज़ का आईडी देती है. |
|
| रेफ़रंस | DocumentReference<AppModelType, DbModelType> | DocumentSnapshot में शामिल दस्तावेज़ का DocumentReference. |
तरीके
| तरीका | मॉडिफ़ायर | ब्यौरा |
|---|---|---|
| data() | दस्तावेज़ के सभी फ़ील्ड को Object के तौर पर हासिल करता है. दस्तावेज़ मौजूद न होने पर undefined लौटाता है. |
|
| मौजूद है() | इस बात के सिग्नल से पता चलता है कि स्नैपशॉट की जगह पर दस्तावेज़ मौजूद है या नहीं. | |
| get(fieldPath) | fieldPath के दिए गए फ़ील्ड को हासिल करता है. अगर दस्तावेज़ या फ़ील्ड मौजूद नहीं है, तो undefined नतीजा दिखाता है. |
DocumentSnapshot.(कंस्ट्रक्टर)
DocumentSnapshot क्लास का एक नया इंस्टेंस बनाता है
हस्ताक्षर:
protected constructor();
DocumentSnapshot.id
DocumentSnapshot की प्रॉपर्टी, जो दस्तावेज़ का आईडी देती है.
हस्ताक्षर:
get id(): string;
DocumentSnapshot.ref
DocumentSnapshot में शामिल दस्तावेज़ का DocumentReference.
हस्ताक्षर:
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 | किसी खास फ़ील्ड का पाथ (उदाहरण के लिए, 'foo' या 'foo.bar'). |
लौटाए जाने वाले प्रॉडक्ट:
कोई भी
अगर दस्तावेज़ में ऐसा कोई फ़ील्ड मौजूद नहीं है, तो फ़ील्ड की तय जगह का डेटा या इसके बारे में जानकारी नहीं होती.