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