@firebase/firestore

फ़ंक्शन

फ़ंक्शन	ब्यौरा
फ़ंक्शन(ऐप्लिकेशन, ...)
getFirestore(ऐप्लिकेशन)	यह विकल्प, दिए गए FirebaseApp से जुड़ा डिफ़ॉल्ट Firestore इंस्टेंस दिखाता है. अगर कोई इंस्टेंस मौजूद नहीं है, तो डिफ़ॉल्ट सेटिंग के साथ नया इंस्टेंस शुरू करता है.
getFirestore(ऐप्लिकेशन, डेटाबेस आईडी)	(बीटा) दिए गए FirebaseApp से जुड़ा मौजूदा Firestore इंस्टेंस दिखाता है. अगर कोई इंस्टेंस मौजूद नहीं है, तो डिफ़ॉल्ट सेटिंग के साथ नया इंस्टेंस शुरू करता है.
initializeFirestore(ऐप्लिकेशन, सेटिंग, डेटाबेस आईडी)	दी गई सेटिंग के साथ Firestore के नए इंस्टेंस को शुरू करता है. इसे सिर्फ़ getFirestore() के साथ-साथ किसी दूसरे फ़ंक्शन से पहले कॉल किया जा सकता है. अगर कस्टम सेटिंग खाली है, तो यह फ़ंक्शन getFirestore() को कॉल करने के बराबर होता है.
फ़ंक्शन(फ़ायरस्टोर, ...)
clearIndexedDbPersistence(फ़ायरस्टोर)	इससे डिवाइस का स्टोरेज खाली हो जाता है. इसमें, सेव किए गए अन्य दस्तावेज़ और कैश मेमोरी में सेव किए गए ऐसे दस्तावेज़ भी शामिल हैं जिन्हें अभी तक मंज़ूरी नहीं मिली है.Firestore इंस्टेंस के शुरू न होने पर (ऐप्लिकेशन बंद किए जाने या ऐप्लिकेशन को पहली बार शुरू किए जाने के बाद) कॉल किया जाना चाहिए. स्टार्टअप पर, इस फ़ंक्शन को दूसरे फ़ंक्शन (InitializeFirestore() या getFirestore() के अलावा) से पहले कॉल किया जाना चाहिए. अगर Firestore इंस्टेंस अब भी चल रहा है, तो प्रॉमिस को failed-precondition के गड़बड़ी कोड के साथ अस्वीकार कर दिया जाएगा.ध्यान दें: clearIndexedDbPersistence() का मकसद मुख्य रूप से भरोसेमंद टेस्ट लिखने में मदद करना है, जो Cloud Firestore का इस्तेमाल करते हैं. यह मौजूदा डेटा को हटाने के लिए एक कारगर तरीका का इस्तेमाल करता है. हालांकि, यह कैश मेमोरी में सेव किए गए डेटा को सुरक्षित तरीके से ओवरराइट करने या उसे वापस पाने की कोशिश नहीं करता. ऐसे ऐप्लिकेशन के लिए जो उपयोगकर्ता सेशन के बीच में कैश मेमोरी में सेव किए गए डेटा को ज़ाहिर करने के बारे में संवेदनशील हैं, हमारा सुझाव है कि परसिस्टेंट न रखें.
कलेक्शन(फ़ायरस्टोर, पाथ, पाथसेगमेंट)	इससे CollectionReference इंस्टेंस मिलता है, जो तय किए गए ऐब्सलूट पाथ पर कलेक्शन के बारे में बताता है.
collectionGroup(firestore, collectionsId)	एक नया Query इंस्टेंस बनाता और दिखाता है. इसमें, डेटाबेस में मौजूद वे सभी दस्तावेज़ शामिल होते हैं जो दिए गए collectionId के साथ कलेक्शन या सब-कलेक्शन में मौजूद होते हैं.
connectFirestoreEmulator(फ़ायरस्टोर, होस्ट, पोर्ट, विकल्प)	Cloud Firestore एम्युलेटर से संपर्क करने के लिए, इस इंस्टेंस में बदलाव करें.ध्यान दें: इस इंस्टेंस का इस्तेमाल कोई भी कार्रवाई करने से पहले किया जाना चाहिए.
disableNetwork(फ़ायरस्टोर)	यह नीति, इस इंस्टेंस के लिए नेटवर्क के इस्तेमाल को बंद करती है. इसे enableNetwork() की मदद से फिर से चालू किया जा सकता है. नेटवर्क के बंद होने पर, स्नैपशॉट लिसनर getDoc() या getDocs() कॉल, कैश मेमोरी से नतीजे दिखाएंगे. साथ ही, नेटवर्क के फिर से शुरू होने तक, डेटा में बदलाव करने की कोई कार्रवाई नहीं की जाएगी.
डॉक(फ़ायरस्टोर, पाथ, पाथसेगमेंट)	इससे DocumentReference इंस्टेंस मिलता है, जो तय किए गए ऐब्सलूट पाथ पर मौजूद दस्तावेज़ से जुड़ा होता है.
enableIndexedDbPersistence(फ़ायरस्टोर, परसिस्टेंस सेटिंग)	अगर मुमकिन हो, तो स्थायी स्टोरेज को चालू करने की कोशिश करता है.अगर ऐसा नहीं हो पाता है, तो enableIndexedDbPersistence(), वादे को अस्वीकार कर देगा या अपवाद की अनुमति देगा. ऐसा न हो पाने की कई वजहें हो सकती हैं. इन वजहों को गड़बड़ी होने पर code की मदद से पहचाना जा सकता है.* पहले से तय की गई शर्त: ऐप्लिकेशन किसी दूसरे ब्राउज़र टैब में पहले से खुला हुआ है. * लागू नहीं किया गया: ब्राउज़र, ऑफ़लाइन पर्सेंटेंस लागू करने के साथ काम नहीं करता है.ध्यान दें कि फ़ेल होने के बाद भी, Firestore इंस्टेंस इस्तेमाल किया जा सकेगा. हालांकि, ऑफ़लाइन परसिस्टेंट मोड बंद रहेगा.ध्यान दें: enableIndexedDbPersistence() को किसी भी दूसरे फ़ंक्शन (initializeFirestore(), getFirestore() या clearIndexedDbPersistence() से पहले कॉल नहीं किया जाना चाहिए.
enableMultiTabIndexedDbPersistence(फ़ायरस्टोर)	अगर मुमकिन हो, तो एक से ज़्यादा टैब वाले स्थायी स्टोरेज को चालू करने की कोशिश करता है. अगर सभी टैब पर यह सुविधा चालू है, तो सभी कार्रवाइयों के लिए लोकल स्टोरेज का ऐक्सेस शेयर होता है. इसमें, कनेक्ट किए गए सभी इंस्टेंस में क्वेरी का शेयर किया गया एक्ज़ीक्यूशन और इंतज़ार के समय के हिसाब से मिलने वाले लोकल दस्तावेज़ अपडेट शामिल हैं.ऐसा न होने पर, enableMultiTabIndexedDbPersistence() प्रॉमिस को अस्वीकार कर देगा या अपवाद की जानकारी देगा. इसके काम न करने की कई वजहें हो सकती हैं, जिनकी पहचान गड़बड़ी पर code की मदद से की जा सकती है.* पहले से तय की गई शर्त: ऐप्लिकेशन किसी अन्य ब्राउज़र टैब में पहले से खुला हुआ है और मल्टी-टैब चालू नहीं है. * लागू नहीं किया गया: ब्राउज़र, ऑफ़लाइन परसिस्टेंस लागू करने की सुविधा के साथ काम नहीं करता.ध्यान दें कि फ़ेल होने के बाद भी, Firestore इंस्टेंस का इस्तेमाल किया जा सकेगा. हालांकि, ऑफ़लाइन परसिस्टेंस बंद रहेगा.
enableNetwork(फ़ायरस्टोर)	यह नीति disableNetwork() पर किए गए पिछले कॉल के बाद, इस Firestore इंस्टेंस के लिए, नेटवर्क के इस्तेमाल को फिर से चालू करती है.
getPersistentcacheIndexManager(फ़ायरस्टोर)	यह फ़ंक्शन, दिए गए Firestore ऑब्जेक्ट के ज़रिए इस्तेमाल किया गया Persistentcache इंडेक्स मैनेजर दिखाता है. PersistentCacheIndexManager इंस्टेंस या null अगर लोकल परसिस्टेंट स्टोरेज का इस्तेमाल नहीं हो रहा है.
loadBundle(firestore, bundleData)	लोकल कैश मेमोरी में Firestore बंडल लोड करता है.
namedQuery(फ़ायरस्टोर, नाम)	लोकल कैश मेमोरी से Firestore क्वेरी को पढ़ता है, जिसकी पहचान दिए गए नाम से की जाती है.नाम वाली क्वेरी, सर्वर साइड पर बंडल में (नतीजे के तौर पर मिलने वाले दस्तावेज़ों के साथ) पैक की जाती हैं और loadBundle का इस्तेमाल करके लोकल कैश में लोड की जाती हैं. लोकल कैश मेमोरी में पहुंचने के बाद, नाम से क्वेरी एक्सट्रैक्ट करने के लिए यह तरीका इस्तेमाल करें.
onSnapshotsInSync(फ़ायरस्टोर, ऑब्ज़र्वर)	सिंक में मौजूद इवेंट के स्नैपशॉट के लिए, लिसनर अटैच करता है. स्नैपशॉट-इन-सिंक इवेंट से पता चलता है कि दिए गए बदलाव से प्रभावित सभी लिसनर को ट्रिगर किया गया है. भले ही, सर्वर के जनरेट किए गए एक बदलाव से कई लिसनर पर असर पड़ा हो.ध्यान दें: स्नैपशॉट-इन-सिंक इवेंट सिर्फ़ यह बताता है कि लिसनर एक-दूसरे के साथ सिंक हैं. हालांकि, इसका इस बात से कोई संबंध नहीं है कि वे स्नैपशॉट सर्वर के साथ सिंक हैं या नहीं. अलग-अलग लिसनर में स्नैपशॉट मेटाडेटा का इस्तेमाल करें और यह तय करें कि स्नैपशॉट कैश मेमोरी से लिया गया है या सर्वर से.
onSnapshotsInSync(firestore, onSync)	सिंक में मौजूद इवेंट के स्नैपशॉट के लिए, लिसनर अटैच करता है. स्नैपशॉट-इन-सिंक इवेंट से पता चलता है कि दिए गए बदलाव से प्रभावित सभी लिसनर को ट्रिगर किया गया है. भले ही, सर्वर के जनरेट किए गए एक बदलाव से कई लिसनर पर असर पड़ा हो.ध्यान दें: स्नैपशॉट-इन-सिंक इवेंट सिर्फ़ यह बताता है कि लिसनर एक-दूसरे के साथ सिंक हैं. हालांकि, इसका इस बात से कोई संबंध नहीं है कि वे स्नैपशॉट सर्वर के साथ सिंक हैं या नहीं. अलग-अलग लिसनर में SnapshotMetadata का इस्तेमाल करके, यह तय करें कि स्नैपशॉट कैश मेमोरी से लिया गया है या सर्वर से.
runTransaction(firestore, updatedFunction, options)	दिए गए updateFunction को लागू करता है. इसके बाद, ट्रांज़ैक्शन में लागू किए गए बदलावों को लागू करने की कोशिश करता है. अगर लेन-देन में पढ़ा गया कोई दस्तावेज़ बदल गया है, तो Cloud Firestore, updateFunction को फिर से इस्तेमाल करने की कोशिश करता है. अगर पांच बार कोशिश करने के बाद भी लेन-देन नहीं हो पाता है, तो लेन-देन नहीं हो पाता.एक बार में 500 बार लिखा जा सकता है.
setIndexConfiguration(फ़ायरस्टोर, कॉन्फ़िगरेशन)	(बीटा वर्शन) लोकल क्वेरी लागू करने के लिए, इंडेक्स करने की सुविधा को कॉन्फ़िगर करता है. इंडेक्स के पिछले कॉन्फ़िगरेशन को बदल दिया जाता है. इंडेक्स कॉन्फ़िगरेशन बनाए रखने के बाद, Promise का समाधान हो जाता है.इंडेक्स में मौजूद एंट्री एसिंक्रोनस तरीके से बनाई जाती हैं. इंडेक्स उपलब्ध न होने पर भी, उन क्वेरी का इस्तेमाल किया जा सकता है जिनके लिए इंडेक्स करना ज़रूरी है. इंडेक्स एंट्री लिखे जाने के बाद, क्वेरी एक्ज़ीक्यूशन अपने-आप इंडेक्स का इस्तेमाल करना शुरू कर देगा.इंडेक्स सिर्फ़ IndexedDb परसिस्टेंस के साथ काम करता है. अगर IndexedDb चालू नहीं है, तो किसी भी इंडेक्स कॉन्फ़िगरेशन को अनदेखा कर दिया जाता है.
setIndexConfiguration(firestore, JSON)	(बीटा वर्शन) लोकल क्वेरी लागू करने के लिए, इंडेक्स करने की सुविधा को कॉन्फ़िगर करता है. इंडेक्स के पिछले कॉन्फ़िगरेशन को बदल दिया जाता है. इंडेक्स कॉन्फ़िगरेशन बनाए रखने के बाद, Promise का समाधान हो जाता है.इंडेक्स में मौजूद एंट्री एसिंक्रोनस तरीके से बनाई जाती हैं. इंडेक्स उपलब्ध न होने पर भी, उन क्वेरी का इस्तेमाल किया जा सकता है जिनके लिए इंडेक्स करना ज़रूरी है. इंडेक्स एंट्री लिखे जाने के बाद, क्वेरी एक्ज़ीक्यूशन अपने-आप इंडेक्स का इस्तेमाल करना शुरू कर देगा.इंडेक्स सिर्फ़ IndexedDb परसिस्टेंस के साथ काम करता है. इंडेक्स कॉन्फ़िगरेशन सेट करने से पहले, enableIndexedDbPersistence() या enableMultiTabIndexedDbPersistence() शुरू करें. अगर IndexedDb चालू नहीं है, तो किसी भी इंडेक्स कॉन्फ़िगरेशन को अनदेखा कर दिया जाता है.यह तरीका, Firebase सीएलआई (firebase firestore:indexes) से एक्सपोर्ट किए गए JSON फ़ॉर्मैट को स्वीकार करता है. अगर JSON का फ़ॉर्मैट अमान्य है, तो इस तरीके में गड़बड़ी होती है.
टर्मिनेट(फ़ायरस्टोर)	दिए गए Firestore इंस्टेंस को खत्म करता है.terminate() को कॉल करने के बाद सिर्फ़ clearIndexedDbPersistence() फ़ंक्शन का इस्तेमाल किया जा सकता है. किसी भी दूसरे फ़ंक्शन में FirestoreError जनरेट होगा.बंद होने के बाद रीस्टार्ट करने के लिए, getFirestore() की मदद से FirebaseFirestore का एक नया इंस्टेंस बनाएं.समझौता खत्म होने पर, कोई भी बकाया अनुरोध रद्द नहीं होता. साथ ही, सर्वर से जवाब का इंतज़ार कर रहे किसी भी वाद का समाधान नहीं होगा. अगर आपने परसिस्टेंस चालू किया है, तो अगली बार इस इंस्टेंस को शुरू करने पर, सर्वर पर इस तरह के ईमेल फिर से भेजे जाने लगेंगे.ध्यान दें: सामान्य स्थितियों में, terminate() को कॉल करना ज़रूरी नहीं है. यह फ़ंक्शन सिर्फ़ तब काम करता है, जब आपको इस इंस्टेंस को उसके सभी संसाधन या clearIndexedDbPersistence() के साथ रिलीज़ करने के लिए ज़बरदस्ती चालू करना हो. इससे यह पक्का किया जा सकता है कि टेस्ट चलाने के दौरान, सभी स्थानीय स्थिति मिटा दी गई है.
waitForPendingWrites(firestore)	सक्रिय उपयोगकर्ता के सभी अनुरोधों को बैकएंड से स्वीकार किए जाने तक इंतज़ार करता है.अगर कोई प्रॉमिस बाकी नहीं है, तो प्रॉमिस तुरंत ठीक हो जाता है. ऐसा न करने पर, प्रॉमिस पहले जारी किए गए सभी राइट के लिए इंतज़ार करता है (इसमें पिछले ऐप्लिकेशन सेशन में लिखे गए भी शामिल हैं), लेकिन यह फ़ंक्शन कॉल करने के बाद जोड़े गए राइट का इंतज़ार नहीं करता है. अगर आपको कुछ और लिखने का इंतज़ार करना है, तो waitForPendingWrites() पर दोबारा कॉल करें.उपयोगकर्ता ने बदलाव किए जाने पर, waitForPendingWrites() के सभी बकाया वादों को अस्वीकार कर दिया जाएगा.
writeBatch(firestore)	लिखने का एक बैच बनाता है, जिसका इस्तेमाल एक ऐटमिक ऑपरेशन के रूप में कई बार लिखने में किया जाता है. किसी एक WriteBatch में ज़्यादा से ज़्यादा 500 बदलाव किए जा सकते हैं.लेन-देन के उलट, लिखने के बैच ऑफ़लाइन उपलब्ध होते हैं. इसलिए, अगर आपको रीड डेटा के लिए अपने डेटा में बदलाव करने की शर्त नहीं रखनी है, तो आपके अनुरोध को प्राथमिकता दी जाती है.
फ़ंक्शन()
count()	एक ऐसा AggregateField ऑब्जेक्ट बनाएं, जिसका इस्तेमाल क्वेरी के नतीजे के सेट में मौजूद दस्तावेज़ों की संख्या की गणना करने के लिए किया जा सके.
deleteField()	मिटाने के लिए फ़ील्ड को मार्क करने के लिए, {merge: true} के साथ updateDoc() या setDoc() के साथ इस्तेमाल के लिए सेंटिनल दिखाता है.
documentId()	किसी दस्तावेज़ के आईडी को रेफ़र करने के लिए, खास सेंटिनल FieldPath दिखाता है. दस्तावेज़ के आईडी के हिसाब से क्रम में लगाने या फ़िल्टर करने के लिए, इसका इस्तेमाल क्वेरी में किया जा सकता है.
getFirestore()	यह फ़ंक्शन डिफ़ॉल्ट FirebaseApp से जुड़ा, मौजूदा डिफ़ॉल्ट Firestore इंस्टेंस दिखाता है. अगर कोई इंस्टेंस मौजूद नहीं है, तो डिफ़ॉल्ट सेटिंग के साथ नया इंस्टेंस शुरू करता है.
memoryEagerGarbageCollector()	MemoryEagerGarbageCollector का इंस्टेंस बनाता है. अगर इस बारे में अलग से नहीं बताया गया है, तो यह डिफ़ॉल्ट रूप से गार्बेज कलेक्टर भी होता है.
पर्सिस्टेंट मल्टीपलTabManager()	PersistentMultipleTabManager का इंस्टेंस बनाता है.
servertimestamp()	लिखे गए डेटा में सर्वर से जनरेट किए गए टाइमस्टैंप को शामिल करने के लिए, setDoc() या updateDoc() के साथ इस्तेमाल किया गया सेंटिनल दिखाता है.
फ़ंक्शन(databaseId, ...)
getFirestore(databaseId)	(बीटा) डिफ़ॉल्ट FirebaseApp से जुड़ा हुआ मौजूदा Firestore इंस्टेंस दिखाता है. अगर कोई इंस्टेंस मौजूद नहीं है, तो डिफ़ॉल्ट सेटिंग के साथ नया इंस्टेंस शुरू करता है.
फ़ंक्शन(एलिमेंट, ...)
ArrayRemove(एलिमेंट)	एक खास वैल्यू दिखाता है, जिसका इस्तेमाल setDoc() के साथ किया जा सकता है या जो सर्वर को सर्वर पर पहले से मौजूद किसी भी अरे वैल्यू से दिए गए एलिमेंट को हटाने के लिए कहता है. दिए गए हर एलिमेंट के सभी इंस्टेंस, अरे से हटा दिए जाएंगे. जिस फ़ील्ड में बदलाव किया जा रहा है, अगर वह पहले से कोई अरे नहीं है, तो उसे खाली अरे से ओवरराइट कर दिया जाएगा.
rangeUnion(एलिमेंट)	एक खास वैल्यू दिखाता है, जिसका इस्तेमाल setDoc() या updateDoc() के साथ किया जा सकता है. यह सर्वर को दिए गए एलिमेंट को, सर्वर पर पहले से मौजूद किसी भी अरे वैल्यू के साथ जोड़ने के लिए कहता है. बताए गए हर उस एलिमेंट को आखिर में जोड़ दिया जाएगा जो कलेक्शन में पहले से मौजूद नहीं है. अगर जिस फ़ील्ड में बदलाव किया जा रहा है वह पहले से कोई अरे नहीं है, तो उसे ऐसे अरे से ओवरराइट कर दिया जाएगा जिसमें ठीक बताए गए एलिमेंट शामिल होंगे.
फ़ंक्शन(फ़ील्ड, ...)
औसत(फ़ील्ड)	एक ऐसा AggregateField ऑब्जेक्ट बनाएं जिसका इस्तेमाल करके, क्वेरी के नतीजों के सेट में मौजूद दस्तावेज़ों की रेंज पर किसी खास फ़ील्ड के औसत का हिसाब लगाया जा सके.
योग(फ़ील्ड)	ऐसा AggregateField ऑब्जेक्ट बनाएं जिसका इस्तेमाल करके, क्वेरी के नतीजों के सेट में मौजूद दस्तावेज़ों की रेंज में किसी खास फ़ील्ड के योग का हिसाब लगाया जा सके.
फ़ंक्शन(fieldPath, ...)
orderBy(fieldPath, guidelinesStr)	ऐसा QueryOrderByConstraint बनाता है जो क्वेरी के नतीजे को बताए गए फ़ील्ड के मुताबिक क्रम से लगाता है. वैकल्पिक रूप से, बढ़ते क्रम में के बजाय घटते क्रम में लगाता है.ध्यान दें: जिन दस्तावेज़ों में तय फ़ील्ड नहीं होता है वे क्वेरी के नतीजे में मौजूद नहीं होंगे.
कहां(fieldPath, opStr, वैल्यू)	एक ऐसा QueryFieldFilterConstraint बनाता है जो यह लागू करता है कि दस्तावेज़ों में तय किया गया फ़ील्ड होना चाहिए और वैल्यू को दिए गए रिलेशन कंस्ट्रेंट को पूरा करना चाहिए.
फ़ंक्शन(fieldValues, ...)
endAt(fieldValues)	ऐसा QueryEndAtConstraint बनाता है, जो क्वेरी के क्रम के हिसाब से दिए गए फ़ील्ड पर खत्म होने वाले नतीजे के सेट में बदलाव करता है. फ़ील्ड की वैल्यू का क्रम, क्वेरी के क्लॉज़ के मुताबिक क्रम से मैच होना चाहिए.
endbefore(fieldValues)	ऐसा QueryEndAtConstraint बनाता है, जो क्वेरी के क्रम के हिसाब से दिए गए फ़ील्ड से पहले खत्म होने वाले नतीजे में बदलाव करता है. फ़ील्ड की वैल्यू का क्रम, क्वेरी के क्लॉज़ के मुताबिक क्रम से मैच होना चाहिए.
startAfter(fieldValues)	यह एक QueryStartAtConstraint बनाता है, जो क्वेरी के क्रम के हिसाब से दिए गए फ़ील्ड के बाद, शुरू होने के लिए सेट किए गए नतीजे में बदलाव करता है. फ़ील्ड की वैल्यू का क्रम, क्वेरी के क्लॉज़ के मुताबिक क्रम से मैच होना चाहिए.
startAt(fieldValues)	यह एक QueryStartAtConstraint बनाता है, जो क्वेरी के क्रम के हिसाब से, दिए गए फ़ील्ड से शुरू होने के लिए सेट किए गए नतीजे में बदलाव करता है. फ़ील्ड की वैल्यू का क्रम, क्वेरी के क्लॉज़ के मुताबिक क्रम से मैच होना चाहिए.
फ़ंक्शन(indexManager, ...)
deleteAllPersistentcacheIndexes(indexManager)	सभी स्थायी कैश इंडेक्स हटा देता है.कृपया ध्यान दें कि यह फ़ंक्शन setIndexConfiguration() के जनरेट किए गए इंडेक्स भी मिटा देगा, जो अब काम नहीं करता.
disablePersistentcacheIndexAutoCreation(indexManager) को लागू न करें	लोकल क्वेरी लागू करने के लिए, स्थायी कैश मेमोरी के इंडेक्स अपने-आप बनाना बंद कर देता है. enablePersistentCacheIndexAutoCreation() को कॉल करके बनाए गए इंडेक्स अब भी लागू होते हैं.
enablePersistentcacheIndexAutoCreation(indexManager)	जब SDK टूल को लगता है कि कैश इंडेक्स से परफ़ॉर्मेंस बेहतर हो सकती है, तब SDK टूल को स्थानीय क्वेरी एक्ज़िक्यूशन के लिए अपने-आप स्थायी कैश इंडेक्स बनाने में मदद मिलती है.यह सुविधा डिफ़ॉल्ट रूप से बंद रहती है.
फ़ंक्शन(बाएं, ...)
aggregateFieldEqual(लेफ़्ट, राइट)	यह बराबरी के दो 'AggregateField` इंस्टेंस की तुलना करता है.
aggregateQuerySnapshotEqual(लेफ़्ट, राइट)	बराबरी के लिए, दो AggregateQuerySnapshot इंस्टेंस की तुलना करता है.दो AggregateQuerySnapshot इंस्टेंस को "बराबर" माना जाता है होना चाहिए, अगर सभी क्वेरी एक जैसी हों और उनमें एक जैसा डेटा हो.
queryEqual(बाएं, दाएं)	अगर दी गई क्वेरी एक ही कलेक्शन पर ले जाती हैं और एक जैसे कंस्ट्रेंट को लागू करती हैं, तो 'सही' दिखाता है.
refEqual(बाएं, दाएं)	अगर दिए गए रेफ़रंस बराबर होते हैं, तो 'सही' दिखाता है.
sSnapshotEqual(बाएं, दाएं)	अगर दिए गए स्नैपशॉट बराबर होते हैं, तो 'सही' दिखाता है.
फ़ंक्शन(limit, ...)
सीमा(सीमा)	ऐसा QueryLimitConstraint बनाता है, जो सिर्फ़ मेल खाने वाले पहले दस्तावेज़ दिखाता है.
limitToLast(limit)	ऐसा QueryLimitConstraint बनाता है, जो सिर्फ़ मिलते-जुलते आखिरी दस्तावेज़ दिखाता है.आपको limitToLast क्वेरी के लिए कम से कम एक orderBy क्लॉज़ तय करना होगा. ऐसा न करने पर, एक्ज़ीक्यूशन के दौरान एक अपवाद पैदा हो जाएगा.
फ़ंक्शन(loglevel, ...)
setLoglevel(logLevel)	Cloud Firestore लॉग (डीबग, गड़बड़ी या साइलेंट) की ज़्यादा जानकारी सेट करता है.
फ़ंक्शन(n, ...)
बढ़ोतरी(n)	ऐसी खास वैल्यू दिखाता है जिसका इस्तेमाल setDoc() या updateDoc() के साथ किया जा सकता है. इससे सर्वर को, दी गई वैल्यू के हिसाब से फ़ील्ड की मौजूदा वैल्यू को बढ़ाने के लिए कहा जाता है.अगर ऑपरेंड या मौजूदा फ़ील्ड की वैल्यू में से किसी एक में फ़्लोटिंग पॉइंट का सटीक इस्तेमाल होता है, तो सभी अंकगणित आईईईई 754 सिमैंटिक को फ़ॉलो करता है. अगर दोनों वैल्यू पूर्णांक हैं, तो JavaScript की सुरक्षित संख्या रेंज (Number.MIN_SAFE_INTEGER से Number.MAX_SAFE_INTEGER) से बाहर की वैल्यू पर भी पूरी तरह से वैल्यू का असर पड़ सकता है. इसके अलावा, Firestore बैकएंड से प्रोसेस होने के बाद, सभी पूर्णांक कार्रवाइयां -2^63 और 2^63-1 के बीच सीमित होती हैं.अगर मौजूदा फ़ील्ड वैल्यू number टाइप की नहीं है या फ़ील्ड मौजूद नहीं है, तो ट्रांसफ़ॉर्मेशन फ़ील्ड को दी गई वैल्यू पर सेट कर देता है.
फ़ंक्शन(क्वेरी, ...)
getAggregateFromServer(query, कुल स्पेस)	असल में दस्तावेज़ डाउनलोड किए बिना, दी गई क्वेरी के नतीजे के सेट में बताए गए एग्रीगेशन की गणना करता है.एग्रीगेशन के लिए इस फ़ंक्शन का इस्तेमाल करना कारगर है, क्योंकि सिर्फ़ फ़ाइनल एग्रीगेशन वैल्यू का इस्तेमाल किया जाता है, न कि दस्तावेज़ डेटा को डाउनलोड किया जाता है. यह फ़ंक्शन उन मामलों में दस्तावेज़ों को एग्रीगेशन कर सकता है जहां नतीजे का सेट पूरी तरह से डाउनलोड करने के लिए बहुत बड़ा है (हज़ारों दस्तावेज़).सर्वर से मिलने वाले नतीजे को किसी स्थानीय स्थिति पर विचार किए बिना पेश किया जाता है, बिना बदलाव किए. इसका मतलब यह है कि लोकल कैश मेमोरी में सेव किए गए दस्तावेज़ों पर ध्यान नहीं दिया जाता और न ही उनमें से किसी भी बदलाव को सर्वर के साथ सिंक नहीं किया गया है. अगर पहले डाउनलोड किए गए नतीजे मौजूद हैं, तो उनका इस्तेमाल नहीं किया जाता. इस फ़ंक्शन को शुरू करने के लिए ज़रूरी है कि सर्वर पर एक राउंड ट्रिप की जाए.
getCountFromServer(क्वेरी)	यह फ़ंक्शन, दस्तावेज़ डाउनलोड किए बिना, दी गई क्वेरी के नतीजों के सेट में मौजूद दस्तावेज़ों की संख्या का हिसाब लगाता है.दस्तावेज़ों की गिनती करने के लिए, इस फ़ंक्शन का इस्तेमाल करना काफ़ी आसान होता है. ऐसा इसलिए, क्योंकि दस्तावेज़ों की गिनती सिर्फ़ आखिर में की जाती है, दस्तावेज़ों की नहीं' डेटा डाउनलोड हो जाता है. यह फ़ंक्शन, उन मामलों में दस्तावेज़ों की गिनती कर सकता है जिनमें नतीजों के सेट को पूरी तरह डाउनलोड करना मुश्किल हो. इसके अलावा, हज़ारों दस्तावेज़ डाउनलोड किए जा सकते हैं.सर्वर से मिले नतीजे में कोई बदलाव नहीं किया जाता और इसे किसी स्थानीय स्थिति पर ध्यान नहीं दिया जाता. इसका मतलब यह है कि लोकल कैश मेमोरी में सेव किए गए दस्तावेज़ों पर ध्यान नहीं दिया जाता और न ही उनमें से किसी भी बदलाव को सर्वर के साथ सिंक नहीं किया गया है. अगर पहले डाउनलोड किए गए नतीजे मौजूद हैं, तो उनका इस्तेमाल नहीं किया जाता. इस फ़ंक्शन को शुरू करने के लिए ज़रूरी है कि सर्वर पर एक राउंड ट्रिप की जाए.
getDocs(क्वेरी)	क्वेरी को एक्ज़ीक्यूट करता है और नतीजों को QuerySnapshot के तौर पर दिखाता है.ध्यान दें: getDocs(), सर्वर से डेटा मिलने का इंतज़ार करते हुए, अप-टू-डेट डेटा उपलब्ध कराने की कोशिश करता है. हालांकि, अगर आप ऑफ़लाइन हैं और सर्वर से कनेक्ट नहीं हो पाता है, तो हो सकता है कि यह कैश मेमोरी में सेव किया गया डेटा वापस कर दे. इस तरीके के बारे में बताने के लिए, getDocsFromcache() या getDocsFromServer() को शुरू करें.
getDocsFromकैश(क्वेरी)	क्वेरी को एक्ज़ीक्यूट करता है और कैश मेमोरी से QuerySnapshot के तौर पर नतीजे दिखाता है. अगर क्वेरी से मेल खाने वाला कोई दस्तावेज़ मौजूदा समय में कैश मेमोरी में सेव नहीं किया जाता है, तो नतीजे का सेट खाली होता है.
getDocsFromServer(क्वेरी)	क्वेरी को एक्ज़ीक्यूट करता है और सर्वर से QuerySnapshot के तौर पर नतीजे दिखाता है. नेटवर्क उपलब्ध न होने पर गड़बड़ी का मैसेज दिखाता है.
onSnapshot(क्वेरी, ऑब्ज़र्वर)	QuerySnapshot इवेंट के लिए लिसनर अटैच करता है. आपके पास अलग-अलग onNext और onError कॉलबैक पास करने या next और error कॉलबैक के साथ, सिंगल ऑब्ज़र्वर ऑब्जेक्ट पास करने का विकल्प होता है. onSnapshot को कॉल करने पर, दिए गए फ़ंक्शन को कॉल करके लिसनर को रद्द किया जा सकता है.ध्यान दें: हालांकि, onCompletion कॉलबैक दिया जा सकता है, लेकिन इसे कभी कॉल नहीं किया जाएगा, क्योंकि स्नैपशॉट स्ट्रीम कभी खत्म नहीं होती.
onSnapshot(क्वेरी, विकल्प, ऑब्ज़र्वर)	QuerySnapshot इवेंट के लिए लिसनर अटैच करता है. आपके पास अलग-अलग onNext और onError कॉलबैक पास करने या next और error कॉलबैक के साथ, सिंगल ऑब्ज़र्वर ऑब्जेक्ट पास करने का विकल्प होता है. onSnapshot को कॉल करने पर, दिए गए फ़ंक्शन को कॉल करके लिसनर को रद्द किया जा सकता है.ध्यान दें: हालांकि, onCompletion कॉलबैक दिया जा सकता है, लेकिन इसे कभी कॉल नहीं किया जाएगा, क्योंकि स्नैपशॉट स्ट्रीम कभी खत्म नहीं होती.
onSnapshot(query, onNext, onError, oncomplete)	QuerySnapshot इवेंट के लिए लिसनर अटैच करता है. आपके पास अलग-अलग onNext और onError कॉलबैक पास करने या next और error कॉलबैक के साथ, सिंगल ऑब्ज़र्वर ऑब्जेक्ट पास करने का विकल्प होता है. onSnapshot को कॉल करने पर, दिए गए फ़ंक्शन को कॉल करके लिसनर को रद्द किया जा सकता है.ध्यान दें: हालांकि, onCompletion कॉलबैक दिया जा सकता है, लेकिन इसे कभी कॉल नहीं किया जाएगा, क्योंकि स्नैपशॉट स्ट्रीम कभी खत्म नहीं होती.
onSnapshot(क्वेरी, विकल्प, onNext, onError, oncomplete)	QuerySnapshot इवेंट के लिए लिसनर अटैच करता है. आपके पास अलग-अलग onNext और onError कॉलबैक पास करने या next और error कॉलबैक के साथ, सिंगल ऑब्ज़र्वर ऑब्जेक्ट पास करने का विकल्प होता है. onSnapshot को कॉल करने पर, दिए गए फ़ंक्शन को कॉल करके लिसनर को रद्द किया जा सकता है.ध्यान दें: हालांकि, onCompletion कॉलबैक दिया जा सकता है, लेकिन इसे कभी कॉल नहीं किया जाएगा, क्योंकि स्नैपशॉट स्ट्रीम कभी खत्म नहीं होती.
query(query, assetFilter, queryConstraints)	क्वेरी का एक ऐसा नया इंस्टेंस बनाता है जिसे बदला नहीं जा सकता. इसे बढ़ाया गया है. इसमें क्वेरी के अन्य कंस्ट्रेंट को भी शामिल किया जाता है.
क्वेरी(क्वेरी, queryConstraints)	क्वेरी का एक ऐसा नया इंस्टेंस बनाता है जिसे बदला नहीं जा सकता. इसे बढ़ाया गया है. इसमें क्वेरी के अन्य कंस्ट्रेंट को भी शामिल किया जाता है.
फ़ंक्शन(queryConstraints, ...)
और(queryConstraints)	एक नया QueryCompositeFilterConstraint बनाता है, जो दिए गए फ़िल्टर कंस्ट्रेंट का कॉम्बिनेशन होता है. कॉम्बिनेशन फ़िल्टर में, कोई दस्तावेज़ तब शामिल होता है, जब वह दिए गए सभी फ़िल्टर के मुताबिक हो.
या(queryConstraints)	एक नया QueryCompositeFilterConstraint बनाता है, जो दिए गए फ़िल्टर कंस्ट्रेंट का डिस्ट्रिब्यूशन होता है. डिसजक्शन फ़िल्टर में कोई दस्तावेज़ तब शामिल होता है, जब वह दिए गए किसी भी फ़िल्टर की शर्तों को पूरा करता है.
फ़ंक्शन(रेफ़रंस, ...)
addDoc(रेफ़रंस, डेटा)	दिए गए डेटा के साथ, बताए गए CollectionReference में नया दस्तावेज़ जोड़ें, इसे अपने-आप दस्तावेज़ आईडी असाइन हो जाएगा.
कलेक्शन(रेफ़रंस, पाथ, पाथसेगमेंट)	इससे CollectionReference इंस्टेंस मिलता है, जो बताए गए रिलेटिव पाथ पर reference के सब-कलेक्शन दिखाता है.
कलेक्शन(रेफ़रंस, पाथ, पाथसेगमेंट)	इससे CollectionReference इंस्टेंस मिलता है, जो बताए गए रिलेटिव पाथ पर reference के सब-कलेक्शन दिखाता है.
deleteDoc(रेफ़रंस)	तय किए गए DocumentReference के ज़रिए रेफ़र किया गया दस्तावेज़ मिटाता है.
दस्तावेज़(रेफ़रंस, पाथ, पाथसेगमेंट)	इससे ऐसा DocumentReference इंस्टेंस मिलता है जो बताए गए रिलेटिव पाथ पर reference में मौजूद किसी दस्तावेज़ के बारे में बताता है. अगर कोई पाथ नहीं डाला गया है, तो लौटाए गए DocumentReference के लिए, अपने-आप जनरेट होने वाले यूनीक आईडी का इस्तेमाल किया जाएगा.
दस्तावेज़(रेफ़रंस, पाथ, पाथसेगमेंट)	इससे ऐसा DocumentReference इंस्टेंस मिलता है जो बताए गए रिलेटिव पाथ पर reference में मौजूद किसी दस्तावेज़ के बारे में बताता है.
getDoc(रेफ़रंस)	इस DocumentReference के बताए गए दस्तावेज़ को पढ़ता है.ध्यान दें: जब भी संभव हो, सर्वर से डेटा मिलने का इंतज़ार करते हुए getDoc(), अप-टू-डेट डेटा उपलब्ध कराने की कोशिश करता है. हालांकि, अगर आप ऑफ़लाइन हैं और सर्वर से कनेक्ट नहीं हो पाता है, तो हो सकता है कि यह कैश मेमोरी में सेव किया गया डेटा वापस कर दे. इस व्यवहार के बारे में बताने के लिए, getDocFromcache() या getDocFromServer() को शुरू करें.
getDocFromकैश(रेफ़रंस)	इस DocumentReference के बताए गए दस्तावेज़ को कैश मेमोरी से पढ़ता है. अगर दस्तावेज़ को फ़िलहाल कैश मेमोरी में सेव नहीं किया गया है, तो यह गड़बड़ी दिखाता है.
getDocFromServer(रेफ़रंस)	इस DocumentReference के बताए गए दस्तावेज़ को सर्वर से पढ़ता है. नेटवर्क उपलब्ध न होने पर गड़बड़ी का मैसेज दिखाता है.
onSnapshot(रेफ़रंस, ऑब्ज़र्वर)	DocumentSnapshot इवेंट के लिए लिसनर अटैच करता है. आपके पास अलग-अलग onNext और onError कॉलबैक पास करने या next और error कॉलबैक के साथ, एक ऑब्ज़र्वर ऑब्जेक्ट पास करने का विकल्प होता है.ध्यान दें: onCompletion कॉलबैक दिया जा सकता है, लेकिन इसे कभी कॉल नहीं किया जाएगा, क्योंकि स्नैपशॉट स्ट्रीम कभी खत्म नहीं होती.
onSnapshot(रेफ़रंस, विकल्प, ऑब्ज़र्वर)	DocumentSnapshot इवेंट के लिए लिसनर अटैच करता है. आपके पास अलग-अलग onNext और onError कॉलबैक पास करने या next और error कॉलबैक के साथ, एक ऑब्ज़र्वर ऑब्जेक्ट पास करने का विकल्प होता है.ध्यान दें: onCompletion कॉलबैक दिया जा सकता है, लेकिन इसे कभी कॉल नहीं किया जाएगा, क्योंकि स्नैपशॉट स्ट्रीम कभी खत्म नहीं होती.
onSnapshot(रेफ़रंस, onNext, onError, oncomplete)	DocumentSnapshot इवेंट के लिए लिसनर अटैच करता है. आपके पास अलग-अलग onNext और onError कॉलबैक पास करने या next और error कॉलबैक के साथ, एक ऑब्ज़र्वर ऑब्जेक्ट पास करने का विकल्प होता है.ध्यान दें: onCompletion कॉलबैक दिया जा सकता है, लेकिन इसे कभी कॉल नहीं किया जाएगा, क्योंकि स्नैपशॉट स्ट्रीम कभी खत्म नहीं होती.
onSnapshot(reference, options, onNext, onError, on खबर)	DocumentSnapshot इवेंट के लिए लिसनर अटैच करता है. आपके पास अलग-अलग onNext और onError कॉलबैक पास करने या next और error कॉलबैक के साथ, एक ऑब्ज़र्वर ऑब्जेक्ट पास करने का विकल्प होता है.ध्यान दें: onCompletion कॉलबैक दिया जा सकता है, लेकिन इसे कभी कॉल नहीं किया जाएगा, क्योंकि स्नैपशॉट स्ट्रीम कभी खत्म नहीं होती.
setDoc(रेफ़रंस, डेटा)	इस DocumentReference के बताए गए दस्तावेज़ में लिखा जाता है. अगर दस्तावेज़ अब तक मौजूद नहीं है, तो इसे बना दिया जाएगा.
setDoc(रेफ़रंस, डेटा, विकल्प)	तय किए गए DocumentReference के बताए गए दस्तावेज़ में लिखता है. अगर दस्तावेज़ अब तक मौजूद नहीं है, तो इसे बना दिया जाएगा. merge या mergeFields उपलब्ध कराने पर, दिए गए डेटा को किसी मौजूदा दस्तावेज़ में मर्ज किया जा सकता है.
updateDoc(रेफ़रंस, डेटा)	बताए गए DocumentReference के बताए गए दस्तावेज़ में फ़ील्ड अपडेट करता है. अगर किसी ऐसे दस्तावेज़ पर लागू किया जाता है जो मौजूद नहीं है, तो अपडेट पूरा नहीं होगा.
updateDoc(reference, फ़ील्ड, वैल्यू, moreFieldsAndValues)	तय किए गए DocumentReference से मिले दस्तावेज़ में मौजूद फ़ील्ड अपडेट होते हैं. अगर किसी दस्तावेज़ पर लागू किया जाता है, तो अपडेट नहीं हो पाएगा.डॉट से अलग किए गए फ़ील्ड पाथ स्ट्रिंग देकर या FieldPath ऑब्जेक्ट देकर, नेस्ट किए गए फ़ील्ड अपडेट किए जा सकते हैं.
फ़ंक्शन(सेटिंग, ...)
memoryLocal कैश(सेटिंग)	MemoryLocalCache का इंस्टेंस बनाता है. SDK टूल को यह बताने के लिए कि किस कैश लेयर का इस्तेमाल करना है, इंस्टेंस को FirestoreSettings.cache पर सेट किया जा सकता है.
memoryLruGarbageCollector(सेटिंग)	MemoryLruGarbageCollector का एक इंस्टेंस बनाता है.टारगेट के साइज़ को सेटिंग पैरामीटर के हिस्से के तौर पर तय किया जा सकता है. कैश मेमोरी का साइज़ तय किए गए साइज़ से ज़्यादा होने पर, कलेक्टर दस्तावेज़ों को मिटाना शुरू कर देगा. कैश मेमोरी का डिफ़ॉल्ट साइज़ 40 एमबी (40 * 1024 * 1024 बाइट) होता है.
पर्सिस्टेंट लोकल कैश(सेटिंग)	PersistentLocalCache का इंस्टेंस बनाता है. SDK टूल को यह बताने के लिए कि किस कैश लेयर का इस्तेमाल करना है, इंस्टेंस को FirestoreSettings.cache पर सेट किया जा सकता है.नोड.js एनवायरमेंट में स्थायी कैश मेमोरी का इस्तेमाल नहीं किया जा सकता.
persistentSingleTabManager(सेटिंग)	PersistentSingleTabManager का इंस्टेंस बनाता है.
फ़ंक्शन(स्नैपशॉट, ...)
endAt(स्नैपशॉट)	एक ऐसा QueryEndAtConstraint बनाता है जो नतीजे के सेट को दिए गए दस्तावेज़ पर खत्म होने के लिए बदलता है (शामिल है). खत्म होने की पोज़िशन, क्वेरी के क्रम के हिसाब से होती है. दस्तावेज़ में वे सभी फ़ील्ड होने चाहिए जो क्वेरी के orderBy में दिए गए हों.
endbefore(स्नैपशॉट)	एक ऐसा QueryEndAtConstraint बनाता है जो नतीजे के सेट को दिए गए दस्तावेज़ (खास तौर पर) से पहले खत्म होने के लिए सेट करता है. खत्म होने की पोज़िशन, क्वेरी के क्रम के हिसाब से होती है. दस्तावेज़ में वे सभी फ़ील्ड होने चाहिए जो क्वेरी के orderBy में दिए गए हों.
startAfter(स्नैपशॉट)	एक QueryStartAtConstraint बनाता है, जो दिए गए दस्तावेज़ (खास तौर पर) के बाद शुरू होने के लिए नतीजे सेट को बदलता है. शुरुआती स्थिति क्वेरी के क्रम के हिसाब से होती है. दस्तावेज़ में वे सभी फ़ील्ड होने चाहिए जो क्वेरी के orderBy में दिए गए हों.
startAt(स्नैपशॉट)	यह एक QueryStartAtConstraint बनाता है, जो दिए गए दस्तावेज़ से शुरू होने वाले नतीजे के सेट में बदलाव करता है, ताकि उसे दिए गए दस्तावेज़ से जोड़ा जा सके. शुरुआती स्थिति क्वेरी के क्रम के हिसाब से होती है. दस्तावेज़ में इस क्वेरी के orderBy में दिए गए सभी फ़ील्ड शामिल होने चाहिए.
फ़ंक्शन(वैल्यू, ...)
वेक्टर(वैल्यू)	संख्याओं के दिए गए कलेक्शन की कॉपी से नया VectorValue बनाता है.

क्लास

क्लास	ब्यौरा
एग्रीगेट फ़ील्ड	यह ऐसे एग्रीगेशन को दिखाता है जिसे Firestore से किया जा सकता है.
AggregateQuerySnapshot	किसी एग्रीगेशन क्वेरी को लागू करने के नतीजे.
बाइट	नहीं बदला जा सकने वाला ऑब्जेक्ट, जो बाइट का कलेक्शन दिखाता है.
कलेक्शनरेफ़रंस	CollectionReference ऑब्जेक्ट का इस्तेमाल, दस्तावेज़ जोड़ने, दस्तावेज़ के रेफ़रंस पाने, और दस्तावेज़ों के लिए क्वेरी करने के लिए किया जा सकता है. इसके लिए, query() का इस्तेमाल किया जा सकता है.
DocumentReference	DocumentReference, Firestore डेटाबेस में दस्तावेज़ की जगह को दिखाता है. इसका इस्तेमाल जगह की जानकारी लिखने, पढ़ने या सुनने के लिए किया जा सकता है. ऐसा हो सकता है कि बताए गए जगह पर मौजूद दस्तावेज़ मौजूद हो या नहीं.
DocumentSnapshot	DocumentSnapshot में, आपके Firestore डेटाबेस के किसी दस्तावेज़ से पढ़ा गया डेटा शामिल होता है. कोई खास फ़ील्ड पाने के लिए, डेटा को .data() या .get(<field>) की मदद से निकाला जा सकता है.ऐसे DocumentSnapshot के लिए जो किसी ऐसे दस्तावेज़ पर ले जाता है जो मौजूद नहीं है, डेटा ऐक्सेस करने पर इसकी वैल्यू 'तय नहीं है' दिखेगी. किसी दस्तावेज़ की मौजूदगी की साफ़ तौर पर पुष्टि करने के लिए, exists() तरीके का इस्तेमाल किया जा सकता है.
FieldPath	FieldPath, दस्तावेज़ में मौजूद फ़ील्ड के बारे में बताता है. पाथ में सिर्फ़ एक फ़ील्ड का नाम (दस्तावेज़ में टॉप लेवल फ़ील्ड का संदर्भ देते हुए) या फ़ील्ड के नामों की सूची (दस्तावेज़ में नेस्ट किए गए फ़ील्ड से जुड़ा हुआ) हो सकती है.फ़ील्ड के नाम देकर एक FieldPath बनाएं. अगर एक से ज़्यादा फ़ील्ड का नाम दिया गया है, तो पाथ किसी दस्तावेज़ में नेस्ट किए गए फ़ील्ड पर ले जाएगा.
फ़ील्ड की वैल्यू	सेंटिनल वैल्यू, जिनका इस्तेमाल set() या update() की मदद से, दस्तावेज़ के फ़ील्ड लिखते समय किया जा सकता है.
फ़ायरस्टोर	Cloud Firestore का सेवा इंटरफ़ेस.इस कंस्ट्रक्टर को सीधे कॉल न करें. इसके बजाय, getFirestore() का इस्तेमाल करें.
Firestoreगड़बड़ी	Firestore ऑपरेशन से एक गड़बड़ी मिली.
जियोपॉइंट	Firestore में भौगोलिक जगह को दिखाने वाला एक ऐसा ऑब्जेक्ट जिसमें बदलाव नहीं किया जा सकता. जगह को अक्षांश/देशांतर जोड़े के तौर पर दिखाया जाता है.अक्षांश और देशांतर [-90, 90] की रेंज में होते हैं. देशांतर वैल्यू [-180, 180] की रेंज में होती हैं.
LoadBundleTask	यह Firebase बंडल लोड करने वाले टास्क के बारे में बताता है. इससे बंडल लोड होने की प्रोसेस के साथ-साथ, टास्क पूरा होने और गड़बड़ी से जुड़े इवेंट की जानकारी मिलती है.यह एपीआई, Promise<LoadBundleTaskProgress> के साथ काम करता है.
PersistentcacheIndexManager	लोकल क्वेरी एक्ज़ीक्यूट करने के लिए इस्तेमाल किए जाने वाले स्थायी कैश इंडेक्स कॉन्फ़िगर करने के लिए PersistentCacheIndexManager.इस्तेमाल करने के लिए, getPersistentCacheIndexManager() पर कॉल करें.
क्वेरी	Query ऐसी क्वेरी के बारे में बताता है जिसे पढ़ा या सुना जा सकता है. फ़िल्टर और क्रम जोड़कर भी बेहतर Query ऑब्जेक्ट बनाए जा सकते हैं.
QueryCompositeFilterConstraint	QueryCompositeFilterConstraint का इस्तेमाल, एक से ज़्यादा QueryFieldFilterConstraints या QueryCompositeFilterConstraints के लॉजिकल OR या AND की मदद से वैल्यू के तौर पर दिए गए दस्तावेज़ों के सेट को सटीक बनाने के लिए किया जाता है. QueryCompositeFilterConstraint, or() या and() को शुरू करके बनाए जाते हैं. इसके बाद, इन्हें query() में पास किया जा सकता है, ताकि ऐसा नया क्वेरी इंस्टेंस बनाया जा सके जिसमें QueryCompositeFilterConstraint भी शामिल हो.
QueryConstraint	QueryConstraint का इस्तेमाल, Firestore क्वेरी से दिखाए गए दस्तावेज़ों के सेट को सटीक बनाने के लिए किया जाता है. QueryConstraint को where(), orderBy(), startAt(), startAfter(), endAfter(), endAt(), limit(), limitToLast(), limitToLast() को लागू करने से बनाया जाता है. इसके बाद, क्वेरी() बनाने के लिए, एक नई क्वेरी पास की जा सकती हैQueryConstraint
QueryDocumentSnapshot	QueryDocumentSnapshot में, क्वेरी के हिस्से के तौर पर आपके Firestore डेटाबेस में मौजूद किसी दस्तावेज़ से पढ़ा गया डेटा शामिल होता है. इस बात की गारंटी है कि दस्तावेज़ मौजूद रहेगा. साथ ही, किसी खास फ़ील्ड को पाने के लिए, इसका डेटा .data() या .get(<field>) की मदद से निकाला जा सकता है.QueryDocumentSnapshot DocumentSnapshot जैसा ही एपीआई प्लैटफ़ॉर्म उपलब्ध कराता है. क्वेरी के नतीजों में सिर्फ़ मौजूदा दस्तावेज़ शामिल हैं. इसलिए, exists प्रॉपर्टी हमेशा सही होगी और data() कभी भी 'undefined' नहीं दिखाएगा.
QueryEndAtConstraint	QueryEndAtConstraint का इस्तेमाल, Firestore क्वेरी से मिले नतीजों के सेट के आखिर से दस्तावेज़ों को हटाने के लिए किया जाता है. QueryEndAtConstraint को endAt() या endbefore() को लागू करके बनाया जाता है. इसके बाद, इसे query() को पास किया जा सकता है, ताकि एक ऐसा नया क्वेरी इंस्टेंस बनाया जा सके जिसमें यह QueryEndAtConstraint भी शामिल हो.
QueryFieldFilterConstraint	QueryFieldFilterConstraint का इस्तेमाल, एक या एक से ज़्यादा दस्तावेज़ के फ़ील्ड को फ़िल्टर करके, Firestore क्वेरी से मिले दस्तावेज़ों के सेट को सटीक बनाने के लिए किया जाता है. QueryFieldFilterConstraint को where() को लागू करके बनाया जाता है. इसके बाद, इसे query() में पास किया जा सकता है, ताकि ऐसा नया क्वेरी इंस्टेंस बनाया जा सके जिसमें यह QueryFieldFilterConstraint भी शामिल हो.
QuerylimitConstraint	QueryLimitConstraint का इस्तेमाल, Firestore क्वेरी से दिखाए जाने वाले दस्तावेज़ों की संख्या को सीमित करने के लिए किया जाता है. QueryLimitConstraint को limit() या limitToLast() को लागू करके बनाया जाता है. इसके बाद, इसे query() को पास किया जा सकता है, ताकि एक ऐसा नया क्वेरी इंस्टेंस बनाया जा सके जिसमें यह QueryLimitConstraint भी शामिल हो.
QueryOrderByConstraint	QueryOrderByConstraint का इस्तेमाल, Firestore क्वेरी से दिखाए गए दस्तावेज़ों के सेट को क्रम से लगाने के लिए किया जाता है. QueryOrderByConstraint को orderBy() का इस्तेमाल करके बनाया जाता है. इसके बाद, इसे query() में पास किया जा सकता है, ताकि एक ऐसा नया क्वेरी इंस्टेंस बनाया जा सके जिसमें यह QueryOrderByConstraint भी शामिल हो.ध्यान दें: जिन दस्तावेज़ों में OrderBy फ़ील्ड नहीं होगा वे क्वेरी के नतीजे में मौजूद नहीं होंगे.
QuerySnapshot	QuerySnapshot में, शून्य या उससे ज़्यादा DocumentSnapshot ऑब्जेक्ट हैं, जो क्वेरी के नतीजे दिखाते हैं. docs प्रॉपर्टी से दस्तावेज़ों को कलेक्शन के तौर पर ऐक्सेस किया जा सकता है या forEach तरीके का इस्तेमाल करके इनकी गिनती की जा सकती है. empty और size प्रॉपर्टी की मदद से, दस्तावेज़ों की संख्या तय की जा सकती है.
QueryStartAtConstraint	QueryStartAtConstraint का इस्तेमाल, Firestore क्वेरी से मिले नतीजों के सेट की शुरुआत से दस्तावेज़ों को हटाने के लिए किया जाता है. QueryStartAtConstraint को startAt() या startAfter() को लागू करके बनाया जाता है. इसके बाद, उन्हें query() को पास किया जा सकता है, ताकि एक ऐसा नया क्वेरी इंस्टेंस बनाया जा सके जिसमें यह QueryStartAtConstraint भी शामिल हो.
Snapshotमेटाडेटा	स्नैपशॉट के बारे में मेटाडेटा, जिसमें स्नैपशॉट की स्थिति के बारे में बताया गया है.
टाइमस्टैंप	Timestamp, किसी भी टाइम ज़ोन या कैलेंडर से अलग समय के पॉइंट को दिखाता है. इसे यूटीसी एपिच टाइम में, नैनोसेकंड रिज़ॉल्यूशन में सेकंड और सेकंड के रूप में दिखाया जाता है.इसे प्रोलेप्टिक ग्रेगोरियन कैलेंडर का इस्तेमाल करके कोड में बदला जाता है, जो ग्रेगोरियन कैलेंडर को साल एक साल के पीछे तक बढ़ा देता है. इसे यह मानकर कोड में बदला जाता है कि सभी मिनट 60 सेकंड लंबे हैं. इसका मतलब है कि लीप सेकंड "स्मीयर" होते हैं ताकि व्याख्या के लिए किसी लीप सेकंड टेबल की ज़रूरत न पड़े. यह सीमा 0001-01-01T00:00:00Z से 9999-12-31T23:59:59.999999999Z तक है.उदाहरण और अन्य जानकारी के लिए, टाइमस्टैंप की परिभाषा देखें.
लेन-देन	ट्रांज़ैक्शन का रेफ़रंस.लेन-देन के updateFunction को पास किया गया Transaction ऑब्जेक्ट, ट्रांज़ैक्शन के कॉन्टेक्स्ट में डेटा को देखने और उसमें बदलाव करने के तरीके उपलब्ध कराता है. runलेन-देन() देखें.
वेक्टरवैल्यू	Firestore दस्तावेज़ों में वेक्टर टाइप को दिखाता है. का इस्तेमाल करके एक इंस्टेंस बनाएं . वेक्टरवैल्यू
WriteBatch	राइट बैच, जिसका इस्तेमाल एक ऐटॉमिक यूनिट के रूप में कई बार लिखने के लिए किया जाता है.writeBatch() को कॉल करके WriteBatch ऑब्जेक्ट हासिल किया जा सकता है. यह राइट बैच में राइट जोड़ने के तरीके उपलब्ध कराता है. जब तक WriteBatch.commit() को कॉल नहीं किया जाता, तब तक कोई भी लिखा गया कॉन्टेंट शेयर नहीं किया जाएगा या उसे स्थानीय तौर पर देखा जा सकेगा.

इंटरफ़ेस

इंटरफ़ेस	ब्यौरा
एग्रीगेट जानकारी	एग्रीगेशन और उनके उपनामों के सेट की जानकारी देता है.
दस्तावेज़ में बदलाव	DocumentChange, क्वेरी से मैच करने वाले दस्तावेज़ों में बदलाव दिखाता है. इसमें उस दस्तावेज़ की जानकारी होती है जिस पर असर पड़ा है. साथ ही, यह भी पता चलता है कि किस तरह का बदलाव हुआ है.
दस्तावेज़ डेटा	दस्तावेज़ के डेटा (setDoc() के साथ इस्तेमाल के लिए) में वैल्यू के लिए मैप किए गए फ़ील्ड शामिल होते हैं.
प्रयोग के तौर पर लंबा पोलिंग विकल्प	ऐसे विकल्प जो लंबी पोलिंग का इस्तेमाल करने पर, SDK टूल के नेटवर्क ट्रांसपोर्ट (WebChannel) को कॉन्फ़िगर करते हैं.ध्यान दें: यह इंटरफ़ेस "एक्सपेरिमेंट के तौर पर उपलब्ध" है और इसमें बदलाव हो सकता है.FirestoreSettings.experimentalAutoDetectLongPolling, FirestoreSettings.experimentalForceLongPolling, और FirestoreSettings.experimentalLongPollingOptions देखें.
FirestoreDataConverter	withConverter() के ज़रिए कन्वर्टर का इस्तेमाल AppModelType प्रकार के उपयोगकर्ता ऑब्जेक्ट को DbModelType प्रकार के Firestore डेटा में बदलने के लिए किया जाता है.कन्वर्टर का इस्तेमाल करने से आप Firestore से ऑब्जेक्ट को स्टोर और हासिल करते समय सामान्य प्रकार के तर्क तय कर सकते हैं.इस संदर्भ में, "AppModel" एक क्लास है जिसका इस्तेमाल ऐप्लिकेशन में संबंधित जानकारी और फ़ंक्शन को एक साथ पैकेज करने के लिए किया जाता है. उदाहरण के लिए, ऐसे क्लास में जटिल, नेस्ट किए गए डेटा टाइप वाली प्रॉपर्टी, मेमो बनाने के लिए इस्तेमाल की जाने वाली प्रॉपर्टी, Firestore के साथ काम न करने वाली प्रॉपर्टी (जैसे कि symbol और bigint), और कंपाउंड ऑपरेशन पूरे करने वाले हेल्पर फ़ंक्शन हो सकते हैं. इस तरह की क्लास Firestore डेटाबेस में सेव करने के लिए सही और/या मुमकिन नहीं होती हैं. इसके बजाय, इस तरह की क्लास के इंस्टेंस को "पुराने JavaScript ऑब्जेक्ट" में बदलना होगा (POJO) खास तौर पर शुरुआती प्रॉपर्टी वाले, जो संभावित रूप से अन्य POJO या POJO के कलेक्शन में नेस्ट किए गए होते हैं. इस कॉन्टेक्स्ट में, इस टाइप को "DbModel" कहा जाता है और यह एक ऐसी चीज़ होगी, जो Firestore में बने रहने के लिहाज़ से सही होगी. सुविधा के लिए, ऐप्लिकेशन FirestoreDataConverter को लागू कर सकते हैं और DocumentReference या Query जैसे Firestore ऑब्जेक्ट के साथ कन्वर्टर को रजिस्टर कर सकते हैं. ऐसा करके, उन्हें Firestore में स्टोर करते समय AppModel को DbModel में अपने-आप बदल दिया जाता है. साथ ही, Firestore से वापस पाने के दौरान DbModel को AppModel में बदला जा सकता है.
FirestoreSettings	आपके Cloud Firestore इंस्टेंस के लिए, कस्टम कॉन्फ़िगरेशन तय करता है. किसी दूसरे तरीके का इस्तेमाल करने से पहले, आपको इन्हें सेट करना होगा.
इंडेक्स	(बीटा) Firestore इंडेक्स की SDK टूल की परिभाषा.
इंडेक्स कॉन्फ़िगरेशन	(बीटा) लोकल क्वेरी एक्ज़िक्यूशन को तेज़ करने के लिए Firestore इंडेक्स की सूची.इंडेक्स डेफ़िनिशन के फ़ॉर्मैट की जानकारी के लिए JSON फ़ॉर्मैट देखें.
इंडेक्स फ़ील्ड	(बीटा) इंडेक्स कॉन्फ़िगरेशन में मौजूद सिंगल फ़ील्ड एलिमेंट.
LoadBundleTaskProग्रेस	यह बंडल लोड होने की स्थिति का अपडेट या आखिरी स्थिति दिखाता है.
Memoryकैशसेटिंग	MemoryLocalCache इंस्टेंस कॉन्फ़िगर करने के लिए, सेटिंग ऑब्जेक्ट.
MemoryEagerGarbageCollector	गार्बेज कलेक्टर दस्तावेज़ों को तब मिटा देता है, जब वे किसी ऐक्टिव क्वेरी का हिस्सा न हों और उनमें कोई लोकल म्यूटेशन न हों.यह कलेक्टर, SDK से कम से कम मेमोरी फ़ुटप्रिंट को पक्का करने की कोशिश करता है. इससे, ऑफ़लाइन क्वेरी के लिए या कैश मेमोरी में सीधे क्वेरी के लिए दस्तावेज़ों को कैश मेमोरी में सेव न किए जाने का जोखिम हो सकता है.इस कलेक्टर का इंस्टेंस बनाने के लिए, फ़ैक्ट्री फ़ंक्शन का इस्तेमाल करें.
MemoryLocal कैश	यह SDK टूल को मेमोरी में मौजूद कैश मेमोरी उपलब्ध कराता है. यह डिफ़ॉल्ट कैश मेमोरी है, जब तक कि इसे किसी अन्य तरीके से कॉन्फ़िगर न किया जाए.इसका इस्तेमाल करने के लिए, फ़ैक्ट्री फ़ंक्शन का इस्तेमाल करके इंस्टेंस बनाएं. इसके बाद, इंस्टेंस को FirestoreSettings.cache पर सेट करें और सेटिंग ऑब्जेक्ट का इस्तेमाल करके, initializeFirestore को कॉल करें.
MemoryLruGarbageCollector	गार्बेज कलेक्टर, हाल ही में इस्तेमाल किए गए दस्तावेज़ों को कई बैच में मिटाता है.इस कलेक्टर को टारगेट साइज़ के हिसाब से कॉन्फ़िगर किया गया है और यह सिर्फ़ तब इकट्ठा करेगा, जब कैश मेमोरी में सेव किए गए दस्तावेज़, टारगेट साइज़ से ज़्यादा होंगे. इससे बड़ी मेमोरी फ़ुटप्रिंट का खतरा हो सकता है. इससे एक ही क्वेरी या दस्तावेज़ के लिए, बैकएंड क्वेरी को बार-बार करने से बचा जा सकता है.इस कलेक्टर का इंस्टेंस बनाने के लिए, फ़ैक्ट्री फ़ंक्शन का इस्तेमाल करें.
परसिस्टेंस सेटिंग	ऐसी सेटिंग जिन्हें Firestore परसिस्टेंस कॉन्फ़िगर करने के लिए enableIndexedDbPersistence() को पास किया जा सकता है.परसिस्टेंस का इस्तेमाल Node.js के एनवायरमेंट में नहीं किया जा सकता.
परसिस्टेंट कैश सेटिंग	PersistentLocalCache इंस्टेंस को कॉन्फ़िगर करने के लिए सेटिंग ऑब्जेक्ट.नोड.js एनवायरमेंट में स्थायी कैश मेमोरी का इस्तेमाल नहीं किया जा सकता.
परसिस्टेंट लोकल कैश	यह SDK टूल में, IndexedDb के हिसाब से सेव की गई कैश मेमोरी उपलब्ध कराता है.इसका इस्तेमाल करने के लिए, फ़ैक्ट्री फ़ंक्शन का इस्तेमाल करके इंस्टेंस बनाएं. इसके बाद, इंस्टेंस को FirestoreSettings.cache पर सेट करें और सेटिंग ऑब्जेक्ट का इस्तेमाल करके, initializeFirestore को कॉल करें.
PersistentMultiTabManager	कई टैब इस्तेमाल करने वाला टैब मैनेजर. SDK टूल, सभी टैब पर की गई क्वेरी और म्यूटेशन को, SDK टूल का इस्तेमाल करके सिंक करेगा.
PersistentSingleTabManager	केवल एक टैब का समर्थन करने वाला टैब मैनेजर, सभी टैब पर कोई समन्वयन नहीं किया जाएगा.
PersistentSingleTabManagerSettings	PersistentSingleTabManager इंस्टेंस को कॉन्फ़िगर करने के लिए टाइप करें.
SnapshotListenOptions	एक विकल्प ऑब्जेक्ट, जिसे onSnapshot() और QuerySnapshot.doc प्रोसेस() को भेजा जा सकता है. इससे, यह कंट्रोल किया जा सकता है कि नतीजे के सेट में किस तरह के बदलाव शामिल किए जाएं.
स्नैपशॉट के विकल्प	ऐसे विकल्प जो DocumentSnapshot से डेटा वापस पाने का तरीका कॉन्फ़िगर करते हैं. उदाहरण के लिए, सर्वर के टाइमस्टैंप के लिए आपकी पसंद का तरीका, जिसे अब तक उनकी फ़ाइनल वैल्यू पर सेट नहीं किया गया है.
लेन-देन के विकल्प	लेन-देन को पसंद के मुताबिक बनाने के विकल्प.
सदस्यता छोड़ें	onSnapshot() से मिला एक फ़ंक्शन, जो शुरू करने पर लिसनर को हटा देता है.

वैरिएबल

वैरिएबल	ब्यौरा
CACHE_SIZE_SIZE	एलआरयू गार्बेज कलेक्शन को बंद करने के लिए इस्तेमाल किया जाने वाला कॉन्सटेंट. Firestore इंस्टेंस को दी गई सेटिंग पर, इस वैल्यू को cacheSizeBytes के तौर पर सेट करें.

उपनामों का प्रकार

उपनाम टाइप करें	ब्यौरा
AddPrefixToKeys	एक नया मैप दिखाता है, जहां हर कुंजी के शुरू में बाहरी कुंजी को बिंदु से जोड़ा जाता है.
एग्रीगेट फ़ील्ड टाइप	सभी AggregateField टाइप जो Firestore के साथ काम करते हैं उनका कॉम्बिनेशन.
AggregatespecData	ऐसा टाइप जिसकी कुंजियां AggregateSpec से ली जाती हैं और जिनकी वैल्यू, इनपुट AggregateSpec से, संबंधित AggregateField की ओर से किए गए एग्रीगेशन का नतीजा होती हैं.
एग्रीगेट टाइप	यूनियन टाइप, जो परफ़ॉर्म किए जाने वाले एग्रीगेट टाइप को दिखाता है.
childUpdateFields	दिए गए टाइप T1 के लिए, नेस्ट किए गए फ़ील्ड का हिसाब लगाने में मदद करने वाला टूल. इसकी ज़रूरत undefined | {...} (वैकल्पिक प्रॉप्स के लिए होती है) या {a: A} | {b: B} जैसे यूनियन टाइप को बांटने के लिए होती है.इस्तेमाल के इस मामले में, V का इस्तेमाल Record पर T[K] के यूनियन टाइप को बांटने के लिए किया जाता है, क्योंकि T[K] का आकलन एक्सप्रेशन के तौर पर किया जाता है, न कि डिस्ट्रिब्यूट किया गया.https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types देखें
DocumentChangeType	DocumentChange का टाइप 'जोड़ा गया', 'हटाया गया' या 'बदलाव किया गया' हो सकता है.
FirestoreErrorCode	Firestore स्टेटस कोड का सेट. gRPC के ज़रिए दिखाए गए कोड यहां एक जैसे हैं: https://github.com/grpc/grpc/blob/Master/doc/statuscodes.mdसंभावित वैल्यू: - 'cancelled': कार्रवाई रद्द कर दी गई है (आम तौर पर कॉलर की ओर से). - 'जानकारी नहीं है': ऐसी गड़बड़ी या किसी दूसरे गड़बड़ी डोमेन की गड़बड़ी. - 'अमान्य तर्क': क्लाइंट ने कोई अमान्य तर्क बताया है. ध्यान दें कि यह 'पहले से तय की गई शर्त' से अलग है. 'अमान्य-तर्क' यह ऐसे तर्क को दिखाता है जिनमें सिस्टम की स्थिति की परवाह किए बिना समस्या होती है (उदाहरण के लिए, किसी फ़ील्ड का अमान्य नाम). - 'समयसीमा खत्म हो गई है': कार्रवाई पूरी होने से पहले समयसीमा खत्म हो गई है. सिस्टम की स्थिति बदलने वाले ऑपरेशन के लिए, यह गड़बड़ी दिखाई जा सकती है, भले ही कार्रवाई पूरी तरह से पूरी हो गई हो. उदाहरण के लिए, हो सकता है कि किसी सर्वर से सही जवाब मिलने में ज़्यादा समय लगे और समयसीमा खत्म होने में देरी हो. - 'नहीं मिला': अनुरोध किया गया कुछ दस्तावेज़ नहीं मिला. - 'पहले से मौजूद है': हमने जो दस्तावेज़ बनाने की कोशिश की थी वह पहले से मौजूद है. - 'अनुमति नहीं दी गई': कॉलर के पास बताए गए ऑपरेशन को लागू करने की अनुमति नहीं है. - 'संसाधन खत्म': कुछ संसाधन खत्म हो गए हैं. ऐसा शायद हर उपयोगकर्ता के लिए कोटा खत्म हो गया हो या पूरे फ़ाइल सिस्टम में जगह न बची हो. - 'पहले से तय की गई शर्त': ऑपरेशन को अस्वीकार कर दिया गया था क्योंकि सिस्टम कार्रवाई के निष्पादन के लिए ज़रूरी स्थिति में नहीं है. - 'रद्द किया गया': आम तौर पर, लेन-देन रद्द होने जैसी किसी एक साथ काम करने की समस्या की वजह से कार्रवाई रद्द कर दी जाती है. - 'सीमा से बाहर': सही सीमा से बाहर जाने की कोशिश की गई. - 'लागू नहीं है': ऑपरेशन लागू नहीं किया गया है या काम नहीं करता/चालू नहीं है. - 'इंटरनल': अंदरूनी गड़बड़ियां. इसका मतलब है कि मौजूदा सिस्टम से उम्मीद के मुताबिक कुछ इन्वैरिएंट काम नहीं कर रहे हैं. अगर आपको इनमें से कोई एक गड़बड़ी दिखती है, तो इसका मतलब है कि कुछ ठीक से काम नहीं कर रहा है. - 'उपलब्ध नहीं है': यह सेवा फ़िलहाल उपलब्ध नहीं है. यह स्थिति थोड़े समय के लिए होती है और इसे ठीक करने के लिए, बैकऑफ़ के साथ फिर से कोशिश करें. - 'डेटा-लॉस': डेटा को वापस नहीं पाया जा सकता या खराब हो गया. - 'अप्रमाणित': कार्रवाई के लिए अनुरोध में मान्य प्रमाणीकरण क्रेडेंशियल नहीं हैं.
FirestoreLocalकैश	काम करने वाले सभी SDK टूल की कैश लेयर से यूनियन टाइप.
ListenSource	उस सोर्स के बारे में बताएं जिसे क्वेरी सुनती है.कैश और सर्वर, दोनों में होने वाले बदलावों को सुनने के लिए, default पर सेट करें. सिर्फ़ कैश मेमोरी में हुए बदलावों को सुनने के लिए, cache पर सेट करें.
MemoryGarbageCollector	मेमोरी लोकल कैश के लिए, सपोर्ट करने वाले गार्बेज कलेक्टर से यूनियन टाइप.
NestedUpdateFields	हर फ़ील्ड (जैसे कि 'बार') के लिए, नेस्ट की गई सभी कुंजियां ढूंढें (उदाहरण के लिए, {'bar.baz': T1, 'bar.QUx': T2}). उन्हें एक साथ काटकर एक ऐसा मैप बनाएं जिसमें 'ज़रूरी नहीं' के तौर पर मार्क की गई सभी संभावित कुंजियां हों
OrderByDirection	orderBy() क्लॉज़ की दिशा 'ब्यौरा' के तौर पर बताई गई है या 'बढ़ते क्रम में' (घटते क्रम में या बढ़ते क्रम में).
PartialWithFieldValue	यह TypeScript के Partial<T> की तरह है. हालांकि, इसमें नेस्ट किए गए फ़ील्ड को छोड़ा जा सकता है और फ़ील्ड वैल्यू को प्रॉपर्टी की वैल्यू के तौर पर पास किया जा सकता है.
PersistentTabManager	सभी उपलब्ध टैब मैनेजर का यूनियन.
शुरुआती	प्रिमिटिव टाइप.
QueryConstraintType	इस SDK टूल में उपलब्ध अलग-अलग क्वेरी कंस्ट्रेंट के बारे में बताता है.
QueryFilterConstraint	QueryFilterConstraint एक हेल्पर यूनियन टाइप है, जो QueryFieldFilterConstraint और QueryCompositeFilterConstraint को दिखाता है.
QueryNonFilterConstraint	QueryNonFilterConstraint एक हेल्पर यूनियन टाइप है, जो QueryConstraints को दिखाता है, जिनका इस्तेमाल दस्तावेज़ों के सेट को छोटा करने या क्रम से लगाने के लिए किया जाता है. हालांकि, यह दस्तावेज़ के फ़ील्ड पर साफ़ तौर पर फ़िल्टर नहीं करता है. QueryNonFilterConstraint को orderBy(), startAt(), startAfter(), endbefore(), endAt(), limit() या limitToLast() को लागू करके बनाया जाता है. इसके बाद, इसे query() में पास किया जा सकता है.QueryConstraint
SetOptions	एक विकल्प ऑब्जेक्ट, जो setDoc() और कॉल के व्यवहार को कॉन्फ़िगर करता है. इन कॉल को merge: true के साथ SetOptions देकर, टारगेट दस्तावेज़ों को ओवरराइट करने के बजाय, पूरी तरह से मर्ज करने के लिए कॉन्फ़िगर किया जा सकता है.
टास्कस्टेट	इससे बंडल लोड होने वाले टास्क की स्थिति के बारे में पता चलता है.दोनों 'गड़बड़ी' और 'सफलता' मिले सिंक हो रहा है: टास्क रद्द हो जाएगा या पूरा हो जाएगा. इसके बाद, टास्क को रिपोर्ट करने के बाद कोई अपडेट नहीं होगा.
UnionToIntersection	यूनियन टाइप U = T1 | T2 | ... दिए जाने पर, इंटरसेक्टेड टाइप (T1 & T2 & ...) लौटाता है.कंडिशनल टाइप से मिले कंडिशनल टाइप और अनुमान का इस्तेमाल करता है. यह इसलिए काम करता है, क्योंकि कॉन्ट्रा-वैरिएंट पोज़िशन में एक ही टाइप वैरिएबल के लिए कई कैंडिडेट होते हैं. इसकी वजह से, इंटरसेक्शन का अनुमान लगाया जाता है. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection-type
UpdateData	updateDoc() के साथ इस्तेमाल करने के लिए डेटा अपडेट करें. इसमें वैल्यू के लिए मैप किए गए फ़ील्ड पाथ (जैसे कि 'foo' या 'foo.baz') शामिल हैं. जिन फ़ील्ड में बिंदु होते हैं वे दस्तावेज़ में नेस्ट किए गए फ़ील्ड का रेफ़रंस देते हैं. फ़ील्ड वैल्यू को प्रॉपर्टी की वैल्यू के तौर पर पास किया जा सकता है.
WhatFilterOp	where() क्लॉज़ में फ़िल्टर की शर्तों को '&lt;', '&lt;=', '==', '!=', '&gt;=', '&gt;', 'array-contains', 'in', 'array-contains-any', और 'not-in' स्ट्रिंग का इस्तेमाल करके तय किया जाता है.
WithFieldValue	प्रकार सुरक्षा बनाए रखते हुए, फ़ील्ड वैल्यू को प्रॉपर्टी मान के रूप में पास करने की अनुमति देता है.

फ़ंक्शन(ऐप्लिकेशन, ...)

getFirestore(ऐप्लिकेशन)

यह विकल्प, दिए गए FirebaseApp से जुड़ा डिफ़ॉल्ट Firestore इंस्टेंस दिखाता है. अगर कोई इंस्टेंस मौजूद नहीं है, तो डिफ़ॉल्ट सेटिंग के साथ नया इंस्टेंस शुरू करता है.

हस्ताक्षर:

export declare function getFirestore(app: FirebaseApp): Firestore;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ऐप्लिकेशन	FirebaseApp	Firestore इंस्टेंस से जुड़ा FirebaseApp इंस्टेंस.

लौटाए जाने वाले प्रॉडक्ट:

फ़ायरस्टोर

दिए गए ऐप्लिकेशन का डिफ़ॉल्ट Firestore इंस्टेंस.

getFirestore(ऐप्लिकेशन, डेटाबेस आईडी)

इस एपीआई की झलक, डेवलपर को दी जाती है. अगर आपको मिलने वाले सुझाव/राय या शिकायत के आधार पर, इस एपीआई की सेटिंग में बदलाव किया जाता है, तो इसमें बदलाव हो सकता है. प्रोडक्शन एनवायरमेंट में इस एपीआई का इस्तेमाल न करें.

दिए गए FirebaseApp से जुड़ा हुआ मौजूदा Firestore इंस्टेंस दिखाता है. अगर कोई इंस्टेंस मौजूद नहीं है, तो डिफ़ॉल्ट सेटिंग के साथ नया इंस्टेंस शुरू करता है.

हस्ताक्षर:

export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ऐप्लिकेशन	FirebaseApp	Firestore इंस्टेंस से जुड़ा FirebaseApp इंस्टेंस.
डेटाबेस आईडी	स्ट्रिंग	डेटाबेस का नाम.

लौटाए जाने वाले प्रॉडक्ट:

फ़ायरस्टोर

दिए गए ऐप्लिकेशन का नाम Firestore इंस्टेंस.

इनिशलाइज़फ़ायर स्टोर(ऐप्लिकेशन, सेटिंग, डेटाबेस आईडी)

दी गई सेटिंग के साथ Firestore के नए इंस्टेंस को शुरू करता है. इसे सिर्फ़ getFirestore() के साथ-साथ किसी दूसरे फ़ंक्शन से पहले कॉल किया जा सकता है. अगर कस्टम सेटिंग खाली है, तो यह फ़ंक्शन getFirestore() को कॉल करने के बराबर होता है.

हस्ताक्षर:

export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ऐप्लिकेशन	FirebaseApp	वह FirebaseApp जिससे Firestore इंस्टेंस जोड़ा जाएगा.
सेटिंग	FirestoreSettings	Firestore इंस्टेंस को कॉन्फ़िगर करने के लिए सेटिंग ऑब्जेक्ट.
डेटाबेस आईडी	स्ट्रिंग	डेटाबेस का नाम.

लौटाए जाने वाले प्रॉडक्ट:

फ़ायरस्टोर

हाल ही में शुरू किया गया Firestore इंस्टेंस.

फ़ंक्शन(फ़ायरस्टोर, ...)

clearIndexedDbPersistence(फ़ायरस्टोर)

इससे डिवाइस का स्टोरेज खाली हो जाता है. इसमें कैश मेमोरी में सेव किए गए और ऐसे दस्तावेज़ भी शामिल हैं जिन्हें अभी तक नहीं लिखा गया है.

Firestore इंस्टेंस शुरू न होने पर कॉल किया जाना चाहिए (ऐप्लिकेशन को बंद किए जाने या ऐप्लिकेशन को पहली बार शुरू करने के बाद). स्टार्टअप पर, इस फ़ंक्शन को दूसरे फ़ंक्शन (InitializeFirestore() या getFirestore() के अलावा) से पहले कॉल किया जाना चाहिए. अगर Firestore इंस्टेंस अब भी चल रहा है, तो failed-precondition के गड़बड़ी कोड के साथ प्रॉमिस को अस्वीकार कर दिया जाएगा.

ध्यान दें: clearIndexedDbPersistence() को मुख्य रूप से भरोसेमंद टेस्ट लिखने में मदद करने के लिए बनाया गया है. इनमें Cloud Firestore का इस्तेमाल किया जाता है. यह मौजूदा डेटा को हटाने के लिए एक कारगर तरीका का इस्तेमाल करता है. हालांकि, यह कैश मेमोरी में सेव किए गए डेटा को सुरक्षित तरीके से ओवरराइट करने या उसे वापस पाने की कोशिश नहीं करता. हमारा सुझाव है कि उपयोगकर्ता सेशन के बीच में कैश मेमोरी में सेव किए गए डेटा को ज़ाहिर करने से जुड़े ऐप्लिकेशन के लिए, एक जैसा डेटा फ़ॉर्मैट (परसिस्टेंट) न रखें.

हस्ताक्षर:

export declare function clearIndexedDbPersistence(firestore: Firestore): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर	Firestore इंस्टेंस, ताकि स्थायी तौर पर डेटा मिट जाए.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<void>

स्थायी स्टोरेज खाली होने के बाद, Promise की समस्या हल हो जाती है. ऐसा न करने पर, प्रॉमिस को गड़बड़ी की वजह से अस्वीकार कर दिया जाता है.

कलेक्शन(फ़ायरस्टोर, पाथ, पाथसेगमेंट)

इससे CollectionReference इंस्टेंस मिलता है, जो तय किए गए ऐब्सलूट पाथ पर कलेक्शन के बारे में बताता है.

हस्ताक्षर:

export declare function collection(firestore: Firestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर	रूट Firestore इंस्टेंस का रेफ़रंस.
पाथ	स्ट्रिंग	कलेक्शन के लिए स्लैश से अलग किया गया पाथ.
पथ सेगमेंट	स्ट्रिंग[]	पहले आर्ग्युमेंट के हिसाब से लागू किए जाने वाले अतिरिक्त पाथ सेगमेंट.

लौटाए जाने वाले प्रॉडक्ट:

CollectionReference<DocumentData, DocumentData>

CollectionReference इंस्टेंस.

अपवाद

अगर फ़ाइनल पाथ में सेगमेंट की संख्या बराबर है और यह कलेक्शन पर ले नहीं जाता.

collectionsGroup(firestore, collectionsId)

एक नया Query इंस्टेंस बनाता और दिखाता है. इसमें, डेटाबेस में मौजूद वे सभी दस्तावेज़ शामिल होते हैं जो दिए गए collectionId के साथ कलेक्शन या सब-कलेक्शन में मौजूद होते हैं.

हस्ताक्षर:

export declare function collectionGroup(firestore: Firestore, collectionId: string): Query<DocumentData, DocumentData>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर	रूट Firestore इंस्टेंस का रेफ़रंस.
कलेक्शन आईडी	स्ट्रिंग	क्वेरी किए जाने वाले संग्रहों की पहचान करता है. इसमें हर उस कलेक्शन या सब-कलेक्शन को शामिल किया जाएगा जिसके पाथ के आखिरी सेगमेंट के तौर पर यह आईडी मौजूद होगा. इसमें स्लैश नहीं हो सकता.

लौटाए जाने वाले प्रॉडक्ट:

क्वेरी<DocumentData, DocumentData>

Query बनाया गया.

ConnectFirestoreEmulator(फ़ायरस्टोर, होस्ट, पोर्ट, विकल्प)

Cloud Firestore एम्युलेटर से संपर्क करने के लिए, इस इंस्टेंस में बदलाव करें.

ध्यान दें: किसी भी तरह की कार्रवाई के लिए इस इंस्टेंस का इस्तेमाल करने से पहले, इस इंस्टेंस को कॉल करना ज़रूरी है.

हस्ताक्षर:

export declare function connectFirestoreEmulator(firestore: Firestore, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर	एम्युलेटर से कनेक्ट करने के लिए, कॉन्फ़िगर किया जाने वाला Firestore इंस्टेंस.
होस्ट	स्ट्रिंग	एम्युलेटर होस्ट (जैसे: localhost).
पोर्ट	नंबर	एम्युलेटर पोर्ट (उदाहरण: 9000).
विकल्प	{ockUserToken?: EmulatorMockTokenOptions | स्ट्रिंग; } पर स्विच करने के मकसद से, हमसे संपर्क करने के लिए धन्यवाद.

लौटाए जाने वाले प्रॉडक्ट:

अमान्य

defaultNetwork(फ़ायरस्टोर)

यह नीति, इस इंस्टेंस के लिए नेटवर्क के इस्तेमाल को बंद करती है. इसे enableNetwork() की मदद से फिर से चालू किया जा सकता है. नेटवर्क के बंद होने पर, स्नैपशॉट लिसनर getDoc() या getDocs() कॉल, कैश मेमोरी से नतीजे दिखाएंगे. साथ ही, नेटवर्क के फिर से शुरू होने तक, डेटा में बदलाव करने की कोई कार्रवाई नहीं की जाएगी.

हस्ताक्षर:

export declare function disableNetwork(firestore: Firestore): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<void>

नेटवर्क बंद होने के बाद बंद होने वाला Promise.

दस्तावेज़(फ़ायरस्टोर, पाथ, पाथसेगमेंट)

इससे DocumentReference इंस्टेंस मिलता है, जो तय किए गए ऐब्सलूट पाथ पर मौजूद दस्तावेज़ से जुड़ा होता है.

हस्ताक्षर:

export declare function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर	रूट Firestore इंस्टेंस का रेफ़रंस.
पाथ	स्ट्रिंग	दस्तावेज़ के लिए स्लैश से अलग किया गया पाथ.
पथ सेगमेंट	स्ट्रिंग[]	पहले आर्ग्युमेंट के हिसाब से लागू किए जाने वाले अतिरिक्त पाथ सेगमेंट.

लौटाए जाने वाले प्रॉडक्ट:

DocumentReference<DocumentData, DocumentData>

DocumentReference इंस्टेंस.

अपवाद

अगर आखिरी पाथ में सेगमेंट की संख्या विषम है और वह किसी दस्तावेज़ पर ले जाता है.

enabledIndexedDbPersistence(फ़ायरस्टोर, परसिस्टेंस सेटिंग)

चेतावनी: यह एपीआई अब पुराना हो गया है.

आने वाले समय में होने वाली मुख्य रिलीज़ से, इस फ़ंक्शन को हटा दिया जाएगा. इसके बजाय, IndexedDb कैश मेमोरी चालू करने के लिए, FirestoreSettings.localCache को PersistentLocalCache के इंस्टेंस पर सेट करें. FirestoreSettings.localCache के पहले से तय होने पर इस फ़ंक्शन को कॉल करने से अपवाद पैदा होगा.

अगर हो सके, तो स्थायी स्टोरेज को चालू करने की कोशिश करता है.

फ़ेल होने पर, enableIndexedDbPersistence() प्रॉमिस को अस्वीकार कर देगा या अपवाद की अनुमति देगा. ऐसा कई वजहों से हो सकता है, जिनकी पहचान गड़बड़ी वाले code की मदद से की जा सकती है.

* पहले से तय की गई शर्त: ऐप्लिकेशन किसी दूसरे ब्राउज़र टैब में पहले से खुला है. * लागू नहीं किया गया: ब्राउज़र, ऑफ़लाइन पर्सेंटेंस लागू करने के साथ काम नहीं करता.

ध्यान दें कि गड़बड़ी होने के बाद भी, Firestore इंस्टेंस इस्तेमाल किया जा सकता है. हालांकि, ऑफ़लाइन परसिस्टेंस बंद हो जाएगा.

ध्यान दें: enableIndexedDbPersistence() को किसी भी अन्य फ़ंक्शन (InitializeFirestore(), getFirestore() या clearIndexedDbPersistence() को छोड़कर के अलावा, किसी और फ़ंक्शन से पहले कॉल किया जाना चाहिए.

Node.js के साथ लगातार काम करने की सुविधा का इस्तेमाल नहीं किया जा सकता.

हस्ताक्षर:

export declare function enableIndexedDbPersistence(firestore: Firestore, persistenceSettings?: PersistenceSettings): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर	परसिस्टेंस को चालू करने के लिए, Firestore इंस्टेंस.
परसिस्टेंस सेटिंग	परसिस्टेंस सेटिंग	परसिस्टेंस कॉन्फ़िगर करने के लिए, वैकल्पिक सेटिंग ऑब्जेक्ट.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<void>

Promise, जो स्थायी स्टोरेज की सुविधा को चालू करने के बारे में बताता है.

सक्षम करेंMultiTabIndexedDbPersistence(फ़ायरस्टोर)

चेतावनी: यह एपीआई अब पुराना हो गया है.

आने वाले समय में होने वाली मुख्य रिलीज़ से, इस फ़ंक्शन को हटा दिया जाएगा. इसके बजाय, इंडेक्स की गई db की कैश मेमोरी को चालू करने के लिए, FirestoreSettings.localCache को PersistentLocalCache के इंस्टेंस पर सेट करें. FirestoreSettings.localCache के पहले से तय होने पर इस फ़ंक्शन को कॉल करने से अपवाद पैदा होगा.

अगर मुमकिन हो, तो एक से ज़्यादा टैब वाले स्थायी स्टोरेज को चालू करने की कोशिश करता है. अगर सभी टैब पर यह सुविधा चालू है, तो सभी कार्रवाइयों के लिए लोकल परसिस्टेंस का ऐक्सेस शेयर होता है. इसमें क्वेरी का शेयर किया गया एक्ज़ीक्यूशन और कनेक्ट किए गए सभी इंस्टेंस में, इंतज़ार के समय के हिसाब से मिलने वाले स्थानीय दस्तावेज़ के अपडेट शामिल हैं.

फ़ेल होने पर, enableMultiTabIndexedDbPersistence() प्रॉमिस को अस्वीकार कर देगा या अपवाद की अनुमति देगा. ऐसा कई वजहों से हो सकता है, जिनकी पहचान गड़बड़ी वाले code की मदद से की जा सकती है.

* पहले से तय की गई शर्त: ऐप्लिकेशन किसी दूसरे ब्राउज़र टैब में पहले से खुला है और मल्टी-टैब चालू नहीं है. * लागू नहीं किया गया: ब्राउज़र, ऑफ़लाइन पर्सेंटेंस लागू करने के साथ काम नहीं करता.

ध्यान दें कि गड़बड़ी होने के बाद भी, Firestore इंस्टेंस इस्तेमाल किया जा सकता है. हालांकि, ऑफ़लाइन परसिस्टेंस बंद हो जाएगा.

हस्ताक्षर:

export declare function enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर	परसिस्टेंस को चालू करने के लिए, Firestore इंस्टेंस.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<void>

Promise, जो स्थायी स्टोरेज की सुविधा को चालू करने के बारे में बताता है.

enabledNetwork(फ़ायरस्टोर)

यह नीति disableNetwork() पर किए गए पिछले कॉल के बाद, इस Firestore इंस्टेंस के लिए, नेटवर्क के इस्तेमाल को फिर से चालू करती है.

हस्ताक्षर:

export declare function enableNetwork(firestore: Firestore): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<void>

नेटवर्क चालू होने के बाद बंद होने वाला Promise.

getPersistentcacheIndexManager(फ़ायरस्टोर)

यह फ़ंक्शन, दिए गए Firestore ऑब्जेक्ट के ज़रिए इस्तेमाल किया गया Persistentcache इंडेक्स मैनेजर दिखाता है.

PersistentCacheIndexManager इंस्टेंस या null अगर लोकल परसिस्टेंट स्टोरेज का इस्तेमाल नहीं हो रहा है.

हस्ताक्षर:

export declare function getPersistentCacheIndexManager(firestore: Firestore): PersistentCacheIndexManager | null;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर

लौटाए जाने वाले प्रॉडक्ट:

PersistentcacheIndexManager | शून्य

loadBundle(firestore, bundleData)

लोकल कैश मेमोरी में Firestore बंडल लोड करता है.

हस्ताक्षर:

export declare function loadBundle(firestore: Firestore, bundleData: ReadableStream<Uint8Array> | ArrayBuffer | string): LoadBundleTask;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर	बंडल लोड करने के लिए Firestore इंस्टेंस.
बंडलडेटा	ReadableStream<Uint8Array> | अरेबफ़र | स्ट्रिंग	लोड किए जाने वाले बंडल को दिखाने वाला ऑब्जेक्ट. मान्य ऑब्जेक्ट हैं ArrayBuffer, ReadableStream<Uint8Array> या string.

लौटाए जाने वाले प्रॉडक्ट:

LoadBundleTask

LoadBundleTask ऑब्जेक्ट, जो कॉलर को प्रोग्रेस अपडेट और पूरा होने या गड़बड़ी से जुड़े इवेंट की सूचना देता है. इसका इस्तेमाल Promise<LoadBundleTaskProgress> के तौर पर किया जा सकता है.

NameQuery(फ़ायरस्टोर, नाम)

लोकल कैश मेमोरी से Firestore क्वेरी को पढ़ता है, जिसकी पहचान दिए गए नाम से की जाती है.

नाम वाली क्वेरी, सर्वर साइड पर बंडल के तौर पर पैक की जाती हैं. साथ ही, इन्हें दस्तावेज़ों के तौर पर भी सेट किया जाता है. साथ ही, loadBundle का इस्तेमाल करके, इन्हें लोकल कैश मेमोरी में लोड किया जाता है. लोकल कैश मेमोरी में पहुंचने के बाद, नाम से क्वेरी एक्सट्रैक्ट करने के लिए यह तरीका इस्तेमाल करें.

हस्ताक्षर:

export declare function namedQuery(firestore: Firestore, name: string): Promise<Query | null>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर	क्वेरी पढ़ने के लिए Firestore इंस्टेंस.
नाम	स्ट्रिंग	क्वेरी का नाम.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<क्वेरी | शून्य>

Promise, जिसे क्वेरी या null की मदद से हल किया गया हो.

onSnapshotsInSync(फ़ायरस्टोर, ऑब्ज़र्वर)

सिंक में मौजूद इवेंट के स्नैपशॉट के लिए, लिसनर अटैच करता है. सिंक में रखे गए स्नैपशॉट इवेंट से पता चलता है कि किसी दिए गए बदलाव से जिन लिसनर पर असर पड़ा है उन सभी लिसनर का ऐक्शन चल रहा है. भले ही, सर्वर से जनरेट किए गए एक बदलाव से कई लिसनर पर असर पड़ा हो.

ध्यान दें: सिंक में मौजूद स्नैपशॉट इवेंट सिर्फ़ यह दिखाता है कि लिसनर एक-दूसरे के साथ सिंक हैं. हालांकि, इससे इस बात की जानकारी नहीं मिलती कि वे स्नैपशॉट सर्वर के साथ सिंक हैं या नहीं. अलग-अलग लिसनर में स्नैपशॉट मेटाडेटा का इस्तेमाल करें और यह तय करें कि स्नैपशॉट कैश मेमोरी से लिया गया है या सर्वर से.

हस्ताक्षर:

export declare function onSnapshotsInSync(firestore: Firestore, observer: {
    next?: (value: void) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर	स्नैपशॉट को सिंक करने के लिए Firestore का इंस्टेंस.
ऑब्ज़र्वर	{ आगे बढ़ें?: (मान: शून्य) => अमान्य; गड़बड़ी?: (गड़बड़ी: FirestoreError) => अमान्य; पूरा हुआ?: () => अमान्य; } पर स्विच करने के मकसद से, हमसे संपर्क करने के लिए धन्यवाद.	एक ऑब्जेक्ट जिसमें next और error कॉलबैक होते हैं.

लौटाए जाने वाले प्रॉडक्ट:

सदस्यता छोड़ें

सदस्यता छोड़ने का फ़ंक्शन, जिसे स्नैपशॉट लिसनर को रद्द करने के लिए कॉल किया जा सकता है.

onSnapshotsInSync(firestore, onSync)

सिंक में मौजूद इवेंट के स्नैपशॉट के लिए, लिसनर अटैच करता है. सिंक में रखे गए स्नैपशॉट इवेंट से पता चलता है कि किसी दिए गए बदलाव से जिन लिसनर पर असर पड़ा है उन सभी लिसनर का ऐक्शन चल रहा है. भले ही, सर्वर से जनरेट किए गए एक बदलाव से कई लिसनर पर असर पड़ा हो.

ध्यान दें: सिंक में मौजूद स्नैपशॉट इवेंट सिर्फ़ यह दिखाता है कि लिसनर एक-दूसरे के साथ सिंक हैं. हालांकि, इससे इस बात की जानकारी नहीं मिलती कि वे स्नैपशॉट सर्वर के साथ सिंक हैं या नहीं. अलग-अलग लिसनर में SnapshotMetadata का इस्तेमाल करके, यह तय करें कि स्नैपशॉट कैश मेमोरी से लिया गया है या सर्वर से.

हस्ताक्षर:

export declare function onSnapshotsInSync(firestore: Firestore, onSync: () => void): Unsubscribe;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर	स्नैपशॉट सिंक करने के लिए Firestore इंस्टेंस.
ऑनसिंक	() => अमान्य	जब भी स्नैपशॉट सुनने वाले सभी लोग एक-दूसरे के साथ सिंक होते हैं, तब कॉलबैक किया जाता है.

लौटाए जाने वाले प्रॉडक्ट:

सदस्यता छोड़ें

सदस्यता छोड़ने का फ़ंक्शन, जिसे स्नैपशॉट लिसनर को रद्द करने के लिए कॉल किया जा सकता है.

रन ट्रांज़ैक्शन(फ़ायरस्टोर, अपडेट फ़ंक्शन, विकल्प)

दिए गए updateFunction को लागू करता है. इसके बाद, ट्रांज़ैक्शन में लागू किए गए बदलावों को लागू करने की कोशिश करता है. अगर लेन-देन में पढ़ा गया कोई दस्तावेज़ बदल गया है, तो Cloud Firestore, updateFunction को फिर से दोहराने की कोशिश करता है. अगर पांच बार कोशिश करने के बाद भी लेन-देन नहीं हो पाता है, तो लेन-देन नहीं हो पाएगा.

एक ही लेन-देन में ज़्यादा से ज़्यादा 500 लिखा जा सकता है.

हस्ताक्षर:

export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर	इस ट्रांज़ैक्शन को चलाने के लिए, Firestore डेटाबेस का रेफ़रंस.
अपडेट फ़ंक्शन	(लेन-देन: लेन-देन) => वादा<T>	लेन-देन के कॉन्टेक्स्ट में एक्ज़ीक्यूट किया जाने वाला फ़ंक्शन.
विकल्प	लेन-देन के विकल्प	विकल्प ऑब्जेक्ट का इस्तेमाल करके, तय की गई ज़्यादा से ज़्यादा संख्या को कॉन्फ़िगर किया जा सकता है.

लौटाए जाने वाले प्रॉडक्ट:

वादा<T>

अगर लेन-देन पूरा हो गया है या साफ़ तौर पर रद्द हो गया है (updateFunction ने प्रॉमिस फ़ेल किया), तो updateFunction की ओर से दिखाया गया प्रॉमिस यहां दिखता है. ऐसा न होने पर, अगर लेन-देन पूरा नहीं होता है, तो अस्वीकार किए गए प्रॉमिस की गड़बड़ी वाला प्रॉमिस दिखाया जाता है.

setIndexConfiguration(फ़ायरस्टोर, कॉन्फ़िगरेशन)

इस एपीआई की झलक, डेवलपर को दी जाती है. अगर आपको मिलने वाले सुझाव/राय या शिकायत के आधार पर, इस एपीआई की सेटिंग में बदलाव किया जाता है, तो इसमें बदलाव हो सकता है. प्रोडक्शन एनवायरमेंट में इस एपीआई का इस्तेमाल न करें.

चेतावनी: यह एपीआई अब पुराना हो गया है.

मैन्युअल तरीके से कैश मेमोरी में इंडेक्स बनाने के बजाय, enablePersistentCacheIndexAutoCreation() का इस्तेमाल करें. इससे SDK टूल यह तय कर सकेगा कि स्थानीय तौर पर चल रही क्वेरी के लिए कैश मेमोरी इंडेक्स बनानी है या नहीं.

लोकल क्वेरी लागू करने के लिए, इंडेक्स करने की नीति को कॉन्फ़िगर करता है. इंडेक्स के पिछले कॉन्फ़िगरेशन को बदल दिया जाता है. इंडेक्स कॉन्फ़िगरेशन को बनाए रखने के बाद, Promise का समाधान हो जाता है.

इंडेक्स एंट्री एसिंक्रोनस तरीके से बनाई जाती हैं. इंडेक्स उपलब्ध न होने पर भी, उन क्वेरी का इस्तेमाल किया जा सकता है जिनके लिए इंडेक्स करना ज़रूरी है. इंडेक्स एंट्री लिखे जाने के बाद, क्वेरी को एक्ज़ीक्यूट करने पर इंडेक्स का इस्तेमाल अपने-आप शुरू हो जाएगा.

इंडेक्स सिर्फ़ IndexedDb परसिस्टेंस के साथ काम करते हैं. अगर IndexedDb चालू नहीं है, तो किसी भी इंडेक्स कॉन्फ़िगरेशन को अनदेखा कर दिया जाता है.

हस्ताक्षर:

export declare function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर	इंडेक्स कॉन्फ़िगर करने के लिए, Firestore इंस्टेंस.
कॉन्फ़िगरेशन	इंडेक्स कॉन्फ़िगरेशन	इंडेक्स की परिभाषा.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<void>

सभी इंडेक्स के सही तरीके से कॉन्फ़िगर हो जाने के बाद, Promise काम करने लगता है.

अपवाद

JSON फ़ॉर्मैट अमान्य होने पर, FirestoreError.

setindexConfiguration(firestore, json)

इस एपीआई की झलक, डेवलपर को दी जाती है. अगर आपको मिलने वाले सुझाव/राय या शिकायत के आधार पर, इस एपीआई की सेटिंग में बदलाव किया जाता है, तो इसमें बदलाव हो सकता है. प्रोडक्शन एनवायरमेंट में इस एपीआई का इस्तेमाल न करें.

चेतावनी: यह एपीआई अब पुराना हो गया है.

मैन्युअल तरीके से कैश मेमोरी में इंडेक्स बनाने के बजाय, enablePersistentCacheIndexAutoCreation() का इस्तेमाल करें. इससे SDK टूल यह तय कर सकेगा कि स्थानीय तौर पर चल रही क्वेरी के लिए कैश मेमोरी इंडेक्स बनानी है या नहीं.

लोकल क्वेरी लागू करने के लिए, इंडेक्स करने की नीति को कॉन्फ़िगर करता है. इंडेक्स के पिछले कॉन्फ़िगरेशन को बदल दिया जाता है. इंडेक्स कॉन्फ़िगरेशन को बनाए रखने के बाद, Promise का समाधान हो जाता है.

इंडेक्स एंट्री एसिंक्रोनस तरीके से बनाई जाती हैं. इंडेक्स उपलब्ध न होने पर भी, उन क्वेरी का इस्तेमाल किया जा सकता है जिनके लिए इंडेक्स करना ज़रूरी है. इंडेक्स एंट्री लिखे जाने के बाद, क्वेरी को एक्ज़ीक्यूट करने पर इंडेक्स का इस्तेमाल अपने-आप शुरू हो जाएगा.

इंडेक्स सिर्फ़ IndexedDb परसिस्टेंस के साथ काम करते हैं. इंडेक्स कॉन्फ़िगरेशन सेट करने से पहले, enableIndexedDbPersistence() या enableMultiTabIndexedDbPersistence() शुरू करें. अगर IndexedDb चालू नहीं है, तो किसी भी इंडेक्स कॉन्फ़िगरेशन को अनदेखा कर दिया जाता है.

यह तरीका, Firebase सीएलआई (firebase firestore:indexes) से एक्सपोर्ट किए गए JSON फ़ॉर्मैट को स्वीकार करता है. अगर JSON का फ़ॉर्मैट अमान्य है, तो इस तरीके में गड़बड़ी होती है.

हस्ताक्षर:

export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर	इंडेक्स कॉन्फ़िगर करने के लिए, Firestore इंस्टेंस.
JSON	स्ट्रिंग	JSON फ़ॉर्मैट, जिसे Firebase सीएलआई ने एक्सपोर्ट किया है.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<void>

सभी इंडेक्स के सही तरीके से कॉन्फ़िगर हो जाने के बाद, Promise काम करने लगता है.

अपवाद

JSON फ़ॉर्मैट अमान्य होने पर, FirestoreError.

बंद करें(फ़ायरस्टोर)

दिए गए Firestore इंस्टेंस को खत्म करता है.

terminate() को कॉल करने के बाद, सिर्फ़ clearIndexedDbPersistence() फ़ंक्शन का इस्तेमाल किया जा सकता है. कोई भी दूसरा फ़ंक्शन FirestoreError दिखाएगा.

खत्म होने के बाद रीस्टार्ट करने के लिए, getFirestore() की मदद से FirebaseFirestore का एक नया इंस्टेंस बनाएं.

समझौता खत्म होने से, किसी भी बकाया लेख को रद्द नहीं किया जाता. साथ ही, ऐसा कोई भी वादा पूरा नहीं होगा जिसके लिए सर्वर से जवाब का इंतज़ार है. अगर आपने परसिस्टेंस चालू किया है, तो अगली बार इस इंस्टेंस को शुरू करने पर, सर्वर पर इन राइट्स को भेजना फिर से शुरू हो जाएगा.

ध्यान दें: सामान्य स्थितियों में, terminate() को कॉल करना ज़रूरी नहीं है. यह फ़ंक्शन सिर्फ़ तब काम करता है, जब आपको इस इंस्टेंस को उसके सभी संसाधन या clearIndexedDbPersistence() के साथ रिलीज़ करने के लिए ज़बरदस्ती चालू करना हो. इससे यह पक्का किया जा सकता है कि टेस्ट चलाने के दौरान, सभी लोकल स्टेट खत्म हो जाएं.

हस्ताक्षर:

export declare function terminate(firestore: Firestore): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<void>

इंस्टेंस बंद होने के बाद सेट होने वाला Promise.

weatherForPendingWrites(फ़ायरस्टोर)

सक्रिय उपयोगकर्ता के सभी अनुरोधों को बैकएंड से स्वीकार किए जाने तक इंतज़ार करता है.

अगर कोई बकाया राइट नहीं है, तो लौटाए गए प्रॉमिस का समाधान तुरंत हो जाता है. ऐसा न करने पर, प्रॉमिस पहले जारी किए गए सभी राइट के लिए इंतज़ार करता है (इसमें पिछले ऐप्लिकेशन सेशन में लिखे गए भी शामिल हैं), लेकिन यह फ़ंक्शन कॉल करने के बाद जोड़े गए राइट का इंतज़ार नहीं करता है. अगर आपको कुछ और लिखने का इंतज़ार करना है, तो waitForPendingWrites() पर दोबारा कॉल करें.

उपयोगकर्ता के बदलावों के दौरान, waitForPendingWrites() के बचे हुए वादों को अस्वीकार कर दिया जाएगा.

हस्ताक्षर:

export declare function waitForPendingWrites(firestore: Firestore): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<void>

Promise का समाधान, बैकएंड के उस अनुरोध को स्वीकार करने के बाद होता है जिसे मंज़ूरी मिलनी बाकी है.

राइट बैच(फ़ायरस्टोर)

लिखने का एक बैच बनाता है, जिसका इस्तेमाल एक ऐटमिक ऑपरेशन के रूप में कई बार लिखने में किया जाता है. किसी एक WriteBatch में ज़्यादा से ज़्यादा 500 बदलाव हो सकते हैं.

ट्रांज़ैक्शन के उलट, राइट बैच ऑफ़लाइन सेव किए जाते हैं. इसलिए, अगर आपको रीड डेटा के लिए अपने लिखने की शर्त की ज़रूरत नहीं है, तो उन्हें प्राथमिकता दी जाती है.

हस्ताक्षर:

export declare function writeBatch(firestore: Firestore): WriteBatch;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ायरस्टोर	फ़ायरस्टोर

लौटाए जाने वाले प्रॉडक्ट:

WriteBatch

ऐसा WriteBatch, जिसका इस्तेमाल एक से ज़्यादा डेटा को ऑटोमैटिक तरीके से एक्ज़ीक्यूट करने के लिए किया जा सकता है.

फ़ंक्शन()

संख्या()

एक ऐसा AggregateField ऑब्जेक्ट बनाएं, जिसका इस्तेमाल क्वेरी के नतीजे के सेट में मौजूद दस्तावेज़ों की संख्या की गणना करने के लिए किया जा सके.

हस्ताक्षर:

export declare function count(): AggregateField<number>;

लौटाए जाने वाले प्रॉडक्ट:

एग्रीगेट फ़ील्ड<number>

मिटाएं फ़ील्ड()

मिटाने के लिए फ़ील्ड को मार्क करने के लिए, {merge: true} के साथ updateDoc() या setDoc() के साथ इस्तेमाल के लिए सेंटिनल दिखाता है.

हस्ताक्षर:

export declare function deleteField(): FieldValue;

लौटाए जाने वाले प्रॉडक्ट:

फ़ील्ड की वैल्यू

दस्तावेज़ आईडी()

किसी दस्तावेज़ के आईडी को रेफ़र करने के लिए, खास सेंटिनल FieldPath दिखाता है. दस्तावेज़ के आईडी के हिसाब से क्रम में लगाने या फ़िल्टर करने के लिए, इसका इस्तेमाल क्वेरी में किया जा सकता है.

हस्ताक्षर:

export declare function documentId(): FieldPath;

लौटाए जाने वाले प्रॉडक्ट:

FieldPath

getFirestore()

यह फ़ंक्शन डिफ़ॉल्ट FirebaseApp से जुड़ा, मौजूदा डिफ़ॉल्ट Firestore इंस्टेंस दिखाता है. अगर कोई इंस्टेंस मौजूद नहीं है, तो डिफ़ॉल्ट सेटिंग के साथ नया इंस्टेंस शुरू करता है.

हस्ताक्षर:

export declare function getFirestore(): Firestore;

लौटाए जाने वाले प्रॉडक्ट:

फ़ायरस्टोर

डिफ़ॉल्ट ऐप्लिकेशन का डिफ़ॉल्ट Firestore इंस्टेंस.

मेमोरीEagerGarbageCollector()

MemoryEagerGarbageCollector का इंस्टेंस बनाता है. अगर इस बारे में अलग से नहीं बताया गया है, तो यह डिफ़ॉल्ट रूप से गार्बेज कलेक्टर भी होता है.

हस्ताक्षर:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

लौटाए जाने वाले प्रॉडक्ट:

MemoryEagerGarbageCollector

परसिस्टेंट मल्टीपलTabManager()

PersistentMultipleTabManager का इंस्टेंस बनाता है.

हस्ताक्षर:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

लौटाए जाने वाले प्रॉडक्ट:

PersistentMultiTabManager

सर्वर टाइमस्टैंप()

लिखे गए डेटा में सर्वर से जनरेट किए गए टाइमस्टैंप को शामिल करने के लिए, setDoc() या updateDoc() के साथ इस्तेमाल किया गया सेंटिनल दिखाता है.

हस्ताक्षर:

export declare function serverTimestamp(): FieldValue;

लौटाए जाने वाले प्रॉडक्ट:

फ़ील्ड की वैल्यू

फ़ंक्शन(databaseId, ...)

getFirestore(databaseId)

इस एपीआई की झलक, डेवलपर को दी जाती है. अगर आपको मिलने वाले सुझाव/राय या शिकायत के आधार पर, इस एपीआई की सेटिंग में बदलाव किया जाता है, तो इसमें बदलाव हो सकता है. प्रोडक्शन एनवायरमेंट में इस एपीआई का इस्तेमाल न करें.

डिफ़ॉल्ट FirebaseApp से जुड़ा हुआ मौजूदा Firestore इंस्टेंस दिखाता है. अगर कोई इंस्टेंस मौजूद नहीं है, तो डिफ़ॉल्ट सेटिंग के साथ नया इंस्टेंस शुरू करता है.

हस्ताक्षर:

export declare function getFirestore(databaseId: string): Firestore;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
डेटाबेस आईडी	स्ट्रिंग	डेटाबेस का नाम.

लौटाए जाने वाले प्रॉडक्ट:

फ़ायरस्टोर

डिफ़ॉल्ट ऐप्लिकेशन का Firestore इंस्टेंस.

फ़ंक्शन(एलिमेंट, ...)

श्रेणीRemove(एलिमेंट)

एक खास वैल्यू दिखाता है, जिसका इस्तेमाल setDoc() के साथ किया जा सकता है या जो सर्वर को सर्वर पर पहले से मौजूद किसी भी अरे वैल्यू से दिए गए एलिमेंट को हटाने के लिए कहता है. दिए गए हर एलिमेंट के सभी इंस्टेंस, अरे से हटा दिए जाएंगे. जिस फ़ील्ड में बदलाव किया जा रहा है, अगर वह पहले से कोई अरे नहीं है, तो उसे खाली अरे से ओवरराइट कर दिया जाएगा.

हस्ताक्षर:

export declare function arrayRemove(...elements: unknown[]): FieldValue;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
एलिमेंट	अज्ञात[]	वे एलिमेंट जिन्हें अरे से हटाना है.

लौटाए जाने वाले प्रॉडक्ट:

फ़ील्ड की वैल्यू

setDoc() या updateDoc() पर कॉल करने के लिए FieldValue निगरानीक

कलेक्शन यूनियन(एलिमेंट)

एक खास वैल्यू दिखाता है, जिसका इस्तेमाल setDoc() या updateDoc() के साथ किया जा सकता है. यह सर्वर को दिए गए एलिमेंट को, सर्वर पर पहले से मौजूद किसी भी अरे वैल्यू के साथ जोड़ने के लिए कहता है. बताए गए हर उस एलिमेंट को आखिर में जोड़ दिया जाएगा जो कलेक्शन में पहले से मौजूद नहीं है. अगर जिस फ़ील्ड में बदलाव किया जा रहा है वह पहले से कोई अरे नहीं है, तो उसे ऐसे अरे से ओवरराइट कर दिया जाएगा जिसमें ठीक बताए गए एलिमेंट शामिल होंगे.

हस्ताक्षर:

export declare function arrayUnion(...elements: unknown[]): FieldValue;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
एलिमेंट	अज्ञात[]	कलेक्शन में जुड़ने वाले एलिमेंट.

लौटाए जाने वाले प्रॉडक्ट:

फ़ील्ड की वैल्यू

setDoc() या updateDoc() पर कॉल करने के लिए FieldValue निगरानीक.

फ़ंक्शन(फ़ील्ड, ...)

औसत(फ़ील्ड)

एक ऐसा AggregateField ऑब्जेक्ट बनाएं जिसका इस्तेमाल करके, क्वेरी के नतीजों के सेट में मौजूद दस्तावेज़ों की रेंज पर किसी खास फ़ील्ड के औसत का हिसाब लगाया जा सके.

हस्ताक्षर:

export declare function average(field: string | FieldPath): AggregateField<number | null>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ील्ड	स्ट्रिंग | FieldPath	पूरे नतीजे के सेट में औसत करने के लिए फ़ील्ड तय करता है.

लौटाए जाने वाले प्रॉडक्ट:

कुल फ़ील्ड<number | शून्य>

योग(फ़ील्ड)

ऐसा AggregateField ऑब्जेक्ट बनाएं जिसका इस्तेमाल करके, क्वेरी के नतीजों के सेट में मौजूद दस्तावेज़ों की रेंज में किसी खास फ़ील्ड के योग का हिसाब लगाया जा सके.

हस्ताक्षर:

export declare function sum(field: string | FieldPath): AggregateField<number>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ील्ड	स्ट्रिंग | FieldPath	नतीजे के सेट में जोड़े जाने वाले फ़ील्ड के बारे में बताता है.

लौटाए जाने वाले प्रॉडक्ट:

एग्रीगेट फ़ील्ड<number>

फ़ंक्शन(fieldPath, ...)

ऑर्डर बाय(फ़ील्ड पाथ, डायरेक्शनStr)

ऐसा QueryOrderByConstraint बनाता है जो क्वेरी के नतीजे को बताए गए फ़ील्ड के हिसाब से क्रम में लगाता है. भले ही, वह बढ़ते क्रम में होने के बजाय घटते क्रम में हो.

ध्यान दें: जिन दस्तावेज़ों में तय फ़ील्ड नहीं है वे क्वेरी के नतीजे में मौजूद नहीं होंगे.

हस्ताक्षर:

export declare function orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): QueryOrderByConstraint;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ील्ड पाथ	स्ट्रिंग | FieldPath	क्रम से लगाने के लिए फ़ील्ड.
डायरेक्शनस्ट्र	OrderByDirection	इसके मुताबिक क्रम से लगाने के लिए वैकल्पिक दिशा ('बढ़ते क्रम' या 'घटते क्रम में'). अगर इसके बारे में नहीं बताया गया है, तो क्रम बढ़ते क्रम में होगा.

लौटाए जाने वाले प्रॉडक्ट:

QueryOrderByConstraint

बनाया गया QueryOrderByConstraint.

कहां(fieldPath, opStr, मान)

एक ऐसा QueryFieldFilterConstraint बनाता है जो यह लागू करता है कि दस्तावेज़ों में तय किया गया फ़ील्ड होना चाहिए और वैल्यू को दिए गए रिलेशन कंस्ट्रेंट को पूरा करना चाहिए.

हस्ताक्षर:

export declare function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryFieldFilterConstraint;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ील्ड पाथ	स्ट्रिंग | FieldPath	तुलना करने का पाथ
ऑपस्ट्र	WhatFilterOp	ऑपरेशन स्ट्रिंग (जैसे कि "<", "<=", "==", "<", "<=", "!=").
value	अज्ञात	तुलना के लिए वैल्यू

लौटाए जाने वाले प्रॉडक्ट:

QueryFieldFilterConstraint

बनाया गया QueryFieldFilterConstraint.

फ़ंक्शन(fieldValues, ...)

endAt(fieldValues)

ऐसा QueryEndAtConstraint बनाता है, जो क्वेरी के क्रम के हिसाब से दिए गए फ़ील्ड पर खत्म होने वाले नतीजे के सेट में बदलाव करता है. फ़ील्ड की वैल्यू का क्रम, क्वेरी के क्लॉज़ के मुताबिक क्रम से मैच होना चाहिए.

हस्ताक्षर:

export declare function endAt(...fieldValues: unknown[]): QueryEndAtConstraint;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ील्ड की वैल्यू	अज्ञात[]	क्वेरी के क्रम के हिसाब से, इस क्वेरी को खत्म करने के लिए फ़ील्ड की वैल्यू.

लौटाए जाने वाले प्रॉडक्ट:

QueryEndAtConstraint

query() को पास करने के लिए एक QueryEndAtConstraint

end before(fieldValues)

ऐसा QueryEndAtConstraint बनाता है, जो क्वेरी के क्रम के हिसाब से दिए गए फ़ील्ड से पहले खत्म होने वाले नतीजे में बदलाव करता है. फ़ील्ड की वैल्यू का क्रम, क्वेरी के क्लॉज़ के मुताबिक क्रम से मैच होना चाहिए.

हस्ताक्षर:

export declare function endBefore(...fieldValues: unknown[]): QueryEndAtConstraint;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ील्ड की वैल्यू	अज्ञात[]	क्वेरी के क्रम के हिसाब से, इस फ़ील्ड की वैल्यू को उससे पहले खत्म करना है.

लौटाए जाने वाले प्रॉडक्ट:

QueryEndAtConstraint

query() को पास करने के लिए एक QueryEndAtConstraint

startAfter(fieldValues)

यह एक QueryStartAtConstraint बनाता है, जो क्वेरी के क्रम के हिसाब से दिए गए फ़ील्ड के बाद, शुरू होने के लिए सेट किए गए नतीजे में बदलाव करता है. फ़ील्ड की वैल्यू का क्रम, क्वेरी के क्लॉज़ के मुताबिक क्रम से मैच होना चाहिए.

हस्ताक्षर:

export declare function startAfter(...fieldValues: unknown[]): QueryStartAtConstraint;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ील्ड की वैल्यू	अज्ञात[]	क्वेरी के क्रम के हिसाब से, इस क्वेरी को शुरू करने के लिए फ़ील्ड.

लौटाए जाने वाले प्रॉडक्ट:

QueryStartAtConstraint

query() को पास करने के लिए, एक QueryStartAtConstraint

startAt(fieldValues)

यह एक QueryStartAtConstraint बनाता है, जो क्वेरी के क्रम के हिसाब से, दिए गए फ़ील्ड से शुरू होने के लिए सेट किए गए नतीजे में बदलाव करता है. फ़ील्ड की वैल्यू का क्रम, क्वेरी के क्लॉज़ के मुताबिक क्रम से मैच होना चाहिए.

हस्ताक्षर:

export declare function startAt(...fieldValues: unknown[]): QueryStartAtConstraint;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ील्ड की वैल्यू	अज्ञात[]	क्वेरी के क्रम के मुताबिक, इस क्वेरी को शुरू करने के लिए फ़ील्ड.

लौटाए जाने वाले प्रॉडक्ट:

QueryStartAtConstraint

query() पर जाने के लिए एक QueryStartAtConstraint.

फ़ंक्शन(indexManager, ...)

DeleteAllPersistentcacheIndexes(indexManager)

सभी स्थायी कैश इंडेक्स हटा देता है.

कृपया ध्यान दें कि यह फ़ंक्शन, setIndexConfiguration() से जनरेट हुए इंडेक्स भी मिटा देगा, जो अब सेवा में नहीं है.

हस्ताक्षर:

export declare function deleteAllPersistentCacheIndexes(indexManager: PersistentCacheIndexManager): void;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
इंडेक्स मैनेजर	PersistentcacheIndexManager

लौटाए जाने वाले प्रॉडक्ट:

अमान्य

discountPersistentcacheIndexAutoCreation(indexManager)

लोकल क्वेरी लागू करने के लिए, स्थायी कैश मेमोरी के इंडेक्स अपने-आप बनाना बंद कर देता है. enablePersistentCacheIndexAutoCreation() को कॉल करके बनाए गए इंडेक्स अब भी लागू होते हैं.

हस्ताक्षर:

export declare function disablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
इंडेक्स मैनेजर	PersistentcacheIndexManager

लौटाए जाने वाले प्रॉडक्ट:

अमान्य

सक्षम करेंPersistentcacheIndexAutoCreation(indexManager)

जब SDK टूल को लगता है कि कैश इंडेक्स से परफ़ॉर्मेंस बेहतर हो सकती है, तब SDK टूल को लोकल क्वेरी एक्ज़िक्यूशन के लिए अपने-आप स्थायी कैश इंडेक्स बनाने में मदद मिलती है.

यह सुविधा, डिफ़ॉल्ट रूप से बंद रहती है.

हस्ताक्षर:

export declare function enablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
इंडेक्स मैनेजर	PersistentcacheIndexManager

लौटाए जाने वाले प्रॉडक्ट:

अमान्य

फ़ंक्शन(बायां, ...)

एग्रीगेट फ़ील्ड बराबर(बाएं, दाएं)

यह बराबरी के दो 'AggregateField` इंस्टेंस की तुलना करता है.

हस्ताक्षर:

export declare function aggregateFieldEqual(left: AggregateField<unknown>, right: AggregateField<unknown>): boolean;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
बाएं	एग्रीगेट फ़ील्ड<जानकारी नहीं है>	इस एग्रीगेट फ़ील्ड की तुलना right से करें.
दाएं	एग्रीगेट फ़ील्ड<जानकारी नहीं है>	इस एग्रीगेट फ़ील्ड की तुलना left से करें.

लौटाए जाने वाले प्रॉडक्ट:

बूलियन

एग्रीगेटQuerySnapshotEqual(बायां, दायां)

बराबरी के लिए, दो AggregateQuerySnapshot इंस्टेंस की तुलना करता है.

AggregateQuerySnapshot के दो इंस्टेंस को "बराबर" माना जाता है होना चाहिए, अगर सभी क्वेरी एक जैसी हों और उनमें एक जैसा डेटा हो.

हस्ताक्षर:

export declare function aggregateQuerySnapshotEqual<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(left: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>, right: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>): boolean;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
बाएं	AggregateQuerySnapshot<AggregatespecType, AppModelType, DbModelType>	तुलना करने के लिए पहले AggregateQuerySnapshot.
दाएं	AggregateQuerySnapshot<AggregatespecType, AppModelType, DbModelType>	तुलना करने के लिए दूसरा AggregateQuerySnapshot.

लौटाए जाने वाले प्रॉडक्ट:

बूलियन

अगर ऑब्जेक्ट "बराबर" हैं, जैसा कि ऊपर बताया गया है, तो true या false.

क्वेरीEqual(लेफ़्ट, राइट)

अगर दी गई क्वेरी एक ही कलेक्शन पर ले जाती हैं और एक जैसे कंस्ट्रेंट को लागू करती हैं, तो 'सही' दिखाता है.

हस्ताक्षर:

export declare function queryEqual<AppModelType, DbModelType extends DocumentData>(left: Query<AppModelType, DbModelType>, right: Query<AppModelType, DbModelType>): boolean;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
बाएं	क्वेरी<AppModelType, DbModelType>	तुलना करने के लिए Query.
दाएं	क्वेरी<AppModelType, DbModelType>	तुलना करने के लिए Query.

लौटाए जाने वाले प्रॉडक्ट:

बूलियन

अगर रेफ़रंस फ़ाइलें एक ही Firestore डेटाबेस में एक ही जगह पर ले जाती हैं, तो सही है.

refEqual(बाएं, दाएं)

अगर दिए गए रेफ़रंस बराबर होते हैं, तो 'सही' दिखाता है.

हस्ताक्षर:

export declare function refEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>, right: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>): boolean;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
बाएं	DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>	तुलना करने के लिए रेफ़रंस.
दाएं	DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>	तुलना करने के लिए रेफ़रंस.

लौटाए जाने वाले प्रॉडक्ट:

बूलियन

अगर रेफ़रंस फ़ाइलें एक ही Firestore डेटाबेस में एक ही जगह पर ले जाती हैं, तो सही है.

स्नैपशॉट बराबर(बाएं, दाएं)

अगर दिए गए स्नैपशॉट बराबर होते हैं, तो 'सही' दिखाता है.

हस्ताक्षर:

export declare function snapshotEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>, right: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>): boolean;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
बाएं	DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>	तुलना करने के लिए स्नैपशॉट.
दाएं	DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>	तुलना करने के लिए स्नैपशॉट.

लौटाए जाने वाले प्रॉडक्ट:

बूलियन

अगर स्नैपशॉट बराबर हों, तो 'सही' होता है.

फ़ंक्शन(सीमा, ...)

सीमा(सीमा)

ऐसा QueryLimitConstraint बनाता है, जो सिर्फ़ मेल खाने वाले पहले दस्तावेज़ दिखाता है.

हस्ताक्षर:

export declare function limit(limit: number): QueryLimitConstraint;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
सीमा	नंबर	लौटाए जाने वाले सामान की ज़्यादा से ज़्यादा संख्या.

लौटाए जाने वाले प्रॉडक्ट:

QuerylimitConstraint

बनाया गया QueryLimitConstraint.

लिमिट(सीमा)

ऐसा QuerylimitConstraint बनाता है, जो सिर्फ़ मिलते-जुलते आखिरी दस्तावेज़ दिखाता है.

आपको limitToLast क्वेरी के लिए कम से कम एक orderBy क्लॉज़ तय करना होगा. ऐसा न करने पर, एक्ज़ीक्यूशन के दौरान अपवाद जोड़ दिया जाएगा.

हस्ताक्षर:

export declare function limitToLast(limit: number): QueryLimitConstraint;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
सीमा	नंबर	लौटाए जाने वाले सामान की ज़्यादा से ज़्यादा संख्या.

लौटाए जाने वाले प्रॉडक्ट:

QuerylimitConstraint

बनाया गया QueryLimitConstraint.

फ़ंक्शन(loglevel, ...)

setLoglevel(logLevel)

Cloud Firestore लॉग (डीबग, गड़बड़ी या साइलेंट) की ज़्यादा जानकारी सेट करता है.

हस्ताक्षर:

export declare function setLogLevel(logLevel: LogLevel): void;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
लॉगलेवल	लॉगलेवल	गतिविधि और गड़बड़ी को लॉग करने के लिए, आपकी तय की गई ज़्यादा शब्दों में जानकारी. इनमें से कोई भी वैल्यू हो सकती है: सबसे ज़्यादा जानकारी वाले लॉगिंग लेवल के लिए debug, खास तौर पर डीबग करने के लिए. सिर्फ़ गड़बड़ियां लॉग करने के लिए, error. silent to turn off logging.

लौटाए जाने वाले प्रॉडक्ट:

अमान्य

फ़ंक्शन(n, ...)

वृद्धि(n)

एक खास वैल्यू दिखाता है, जिसका इस्तेमाल setDoc() या updateDoc() के साथ किया जा सकता है. यह सर्वर को, दी गई वैल्यू के हिसाब से फ़ील्ड की मौजूदा वैल्यू को बढ़ाने के लिए कहता है.

अगर ऑपरेंड या मौजूदा फ़ील्ड की वैल्यू में, फ़्लोटिंग पॉइंट प्रिसिज़न का इस्तेमाल होता है, तो सभी अंकगणित, आईईईई 754 सिमैंटिक का पालन करता है. अगर दोनों वैल्यू पूर्णांक हैं, तो JavaScript की सुरक्षित संख्या रेंज (Number.MIN_SAFE_INTEGER से Number.MAX_SAFE_INTEGER) से बाहर की वैल्यू पर भी वैल्यू का सटीक असर पड़ सकता है. इसके अलावा, Firestore बैकएंड से प्रोसेस होने के बाद, सभी पूर्णांक कार्रवाइयां -2^63 और 2^63-1 के बीच तय होती हैं.

अगर फ़ील्ड की मौजूदा वैल्यू number टाइप की नहीं है या फ़ील्ड मौजूद नहीं है, तो ट्रांसफ़ॉर्मेशन ऐक्शन फ़ील्ड को दी गई वैल्यू पर सेट कर देता है.

हस्ताक्षर:

export declare function increment(n: number): FieldValue;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
n	नंबर	वह वैल्यू जिससे बढ़ोतरी करनी है.

लौटाए जाने वाले प्रॉडक्ट:

फ़ील्ड की वैल्यू

setDoc() या updateDoc() पर कॉल करने के लिए FieldValue निगरानीक

फ़ंक्शन(क्वेरी, ...)

getAggregateFromServer(क्वेरी, इकट्ठा करें)

असल में दस्तावेज़ों को डाउनलोड किए बिना दी गई क्वेरी के नतीजे के सेट में दस्तावेज़ों में बताए गए एग्रीगेशन की गणना करता है.

एग्रीगेशन के लिए यह फ़ंक्शन इस्तेमाल करें. इसकी वजह यह है कि एग्रीगेशन के लिए सिर्फ़ फ़ाइनल वैल्यू इस्तेमाल की जा सकती है, दस्तावेज़ नहीं डेटा को डाउनलोड किया जाता है. यह फ़ंक्शन, उन मामलों में दस्तावेज़ों को एग्रीगेशन कर सकता है जहां नतीजे का सेट पूरी तरह से डाउनलोड करने के लिए बहुत बड़ा है (हज़ारों दस्तावेज़).

सर्वर से मिलने वाले नतीजे को किसी भी स्थानीय स्थिति पर ध्यान दिए बिना दिखाया जाता है और बिना किसी बदलाव के दिखाया जाता है. इसका मतलब यह है कि लोकल कैश मेमोरी में सेव किए गए दस्तावेज़ों पर ध्यान नहीं दिया जाता और न ही उनमें से किसी भी बदलाव को सर्वर के साथ सिंक नहीं किया गया है. अगर पहले डाउनलोड किए गए नतीजे मौजूद हैं, तो उनका इस्तेमाल नहीं किया जाता. इस फ़ंक्शन को शुरू करने के लिए ज़रूरी है कि सर्वर पर एक राउंड ट्रिप की जाए.

हस्ताक्षर:

export declare function getAggregateFromServer<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, aggregateSpec: AggregateSpecType): Promise<AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
query	क्वेरी<AppModelType, DbModelType>	वह क्वेरी जिसके परिणाम का सेट एग्रीगेट किया गया है.
इकट्ठा की गई जानकारी	एग्रीगेटस्पेक्टटाइप	एक AggregateSpec ऑब्जेक्ट, जो नतीजे के सेट पर परफ़ॉर्म करने के लिए एग्रीगेट तय करता है. AggregateSpecification हर एग्रीगेट के लिए उपनामों को तय करता है, जिसका इस्तेमाल एग्रीगेट नतीजा वापस पाने के लिए किया जा सकता है.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<AggregateQuerySnapshot<AggregateSpecificationType, AppModelType, DbModelType>>

उदाहरण

const aggregateSnapshot = await getAggregateFromServer(query, {
  countOfDocs: count(),
  totalHours: sum('hours'),
  averageScore: average('score')
});

const countOfDocs: number = aggregateSnapshot.data().countOfDocs;
const totalHours: number = aggregateSnapshot.data().totalHours;
const averageScore: number | null = aggregateSnapshot.data().averageScore;

getCountFromServer(क्वेरी)

असल में दस्तावेज़ों को डाउनलोड किए बिना, दी गई क्वेरी के नतीजे सेट में दस्तावेज़ों की संख्या की गणना करता है.

दस्तावेज़ों की गिनती करने के लिए इस फ़ंक्शन का इस्तेमाल करना आसान है. ऐसा इसलिए, क्योंकि दस्तावेज़ों की नहीं, बल्कि सिर्फ़ आखिरी गिनती को डेटा डाउनलोड हो जाता है. यह फ़ंक्शन, उन मामलों में दस्तावेज़ों की गिनती कर सकता है जिनमें नतीजे के सेट को पूरी तरह से डाउनलोड करने पर पाबंदी लगाई गई हो. जैसे, हज़ारों दस्तावेज़.

सर्वर से मिलने वाले नतीजे को किसी भी स्थानीय स्थिति पर ध्यान दिए बिना दिखाया जाता है और बिना किसी बदलाव के दिखाया जाता है. इसका मतलब यह है कि लोकल कैश मेमोरी में सेव किए गए दस्तावेज़ों पर ध्यान नहीं दिया जाता और न ही उनमें से किसी भी बदलाव को सर्वर के साथ सिंक नहीं किया गया है. अगर पहले डाउनलोड किए गए नतीजे मौजूद हैं, तो उनका इस्तेमाल नहीं किया जाता. इस फ़ंक्शन को शुरू करने के लिए ज़रूरी है कि सर्वर पर एक राउंड ट्रिप की जाए.

हस्ताक्षर:

export declare function getCountFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<AggregateQuerySnapshot<{
    count: AggregateField<number>;
}, AppModelType, DbModelType>>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
query	क्वेरी<AppModelType, DbModelType>	वह क्वेरी जिसके नतीजे के सेट के साइज़ को कैलकुलेट किया जाता है.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<AggregateQuerySnapshot<{ संख्या: AggregateField<number>; }, AppModelType, DbModelType>>

एक ऐसा प्रॉमिस जिसे सदस्यों की संख्या के साथ हल किया जाएगा; संख्या को snapshot.data().count से वापस लाया जा सकता है. इसमें snapshot वह AggregateQuerySnapshot है जिससे मिलने वाले प्रॉमिस का समाधान होता है.

Docs(क्वेरी)

क्वेरी को एक्ज़ीक्यूट करता है और QuerySnapshot के तौर पर नतीजे दिखाता है.

ध्यान दें: getDocs(), जब भी मुमकिन हो, सर्वर से डेटा मिलने का इंतज़ार करके अप-टू-डेट डेटा उपलब्ध कराने की कोशिश करता है. हालांकि, यह कैश मेमोरी में सेव किया गया डेटा वापस कर सकता है. इसके अलावा, अगर आप ऑफ़लाइन हैं और सर्वर से कनेक्ट नहीं किया जा सकता, तो भी यह प्रोसेस बंद हो सकता है. इस तरीके को बताने के लिए, getDocsFromकैश() या getDocsFromServer() को शुरू करें.

हस्ताक्षर:

export declare function getDocs<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
query	क्वेरी<AppModelType, DbModelType>

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<QuerySnapshot<AppModelType, DbModelType>>

Promise, जिसे क्वेरी के नतीजों के साथ हल किया जाएगा.

getDocsFromकैश(क्वेरी)

क्वेरी को एक्ज़ीक्यूट करता है और कैश मेमोरी से QuerySnapshot के तौर पर नतीजे दिखाता है. अगर क्वेरी से मेल खाने वाला कोई दस्तावेज़ मौजूदा समय में कैश मेमोरी में सेव नहीं किया जाता है, तो नतीजे का सेट खाली होता है.

हस्ताक्षर:

export declare function getDocsFromCache<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
query	क्वेरी<AppModelType, DbModelType>

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<QuerySnapshot<AppModelType, DbModelType>>

Promise, जिसे क्वेरी के नतीजों के साथ हल किया जाएगा.

getDocsFromServer(क्वेरी)

क्वेरी को एक्ज़ीक्यूट करता है और सर्वर से QuerySnapshot के तौर पर नतीजे दिखाता है. नेटवर्क उपलब्ध न होने पर गड़बड़ी का मैसेज दिखाता है.

हस्ताक्षर:

export declare function getDocsFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
query	क्वेरी<AppModelType, DbModelType>

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<QuerySnapshot<AppModelType, DbModelType>>

Promise, जिसे क्वेरी के नतीजों के साथ हल किया जाएगा.

onSnapshot(क्वेरी, ऑब्ज़र्वर)

QuerySnapshot इवेंट के लिए लिसनर अटैच करता है. आपके पास अलग-अलग onNext और onError कॉलबैक पास करने या next और error कॉलबैक के साथ, सिंगल ऑब्ज़र्वर ऑब्जेक्ट पास करने का विकल्प होता है. onSnapshot को कॉल करने पर, लौटाए जाने वाले फ़ंक्शन को कॉल करके लिसनर को रद्द किया जा सकता है.

ध्यान दें: onCompletion कॉलबैक दिया जा सकता है, लेकिन इसे कभी भी कॉल नहीं किया जाएगा, क्योंकि स्नैपशॉट स्ट्रीम कभी खत्म नहीं होती.

हस्ताक्षर:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
query	क्वेरी<AppModelType, DbModelType>	वह क्वेरी जिसे सुनना है.
ऑब्ज़र्वर	{ आगे बढ़ें?: (स्नैपशॉट: QuerySnapshot<AppModelType, DbModelType>) => अमान्य; गड़बड़ी?: (गड़बड़ी: FirestoreError) => अमान्य; पूरा हुआ?: () => अमान्य; } पर स्विच करने के मकसद से, हमसे संपर्क करने के लिए धन्यवाद.	एक ऑब्जेक्ट जिसमें next और error कॉलबैक होते हैं.

लौटाए जाने वाले प्रॉडक्ट:

सदस्यता छोड़ें

सदस्यता छोड़ने का फ़ंक्शन, जिसे स्नैपशॉट लिसनर को रद्द करने के लिए कॉल किया जा सकता है.

onSnapshot(क्वेरी, विकल्प, ऑब्ज़र्वर)

QuerySnapshot इवेंट के लिए लिसनर अटैच करता है. आपके पास अलग-अलग onNext और onError कॉलबैक पास करने या next और error कॉलबैक के साथ, सिंगल ऑब्ज़र्वर ऑब्जेक्ट पास करने का विकल्प होता है. onSnapshot को कॉल करने पर, लौटाए जाने वाले फ़ंक्शन को कॉल करके लिसनर को रद्द किया जा सकता है.

ध्यान दें: onCompletion कॉलबैक दिया जा सकता है, लेकिन इसे कभी भी कॉल नहीं किया जाएगा, क्योंकि स्नैपशॉट स्ट्रीम कभी खत्म नहीं होती.

हस्ताक्षर:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
query	क्वेरी<AppModelType, DbModelType>	वह क्वेरी जिसे सुनना है.
विकल्प	SnapshotListenOptions	सुनने के व्यवहार को कंट्रोल करने के विकल्प.
ऑब्ज़र्वर	{ आगे बढ़ें?: (स्नैपशॉट: QuerySnapshot<AppModelType, DbModelType>) => अमान्य; गड़बड़ी?: (गड़बड़ी: FirestoreError) => अमान्य; पूरा हुआ?: () => अमान्य; } पर स्विच करने के मकसद से, हमसे संपर्क करने के लिए धन्यवाद.	एक ऑब्जेक्ट जिसमें next और error कॉलबैक होते हैं.

लौटाए जाने वाले प्रॉडक्ट:

सदस्यता छोड़ें

सदस्यता छोड़ने का फ़ंक्शन, जिसे स्नैपशॉट लिसनर को रद्द करने के लिए कॉल किया जा सकता है.

onSnapshot(क्वेरी, onNext, onError, oncomplete)

QuerySnapshot इवेंट के लिए लिसनर अटैच करता है. आपके पास अलग-अलग onNext और onError कॉलबैक पास करने या next और error कॉलबैक के साथ, सिंगल ऑब्ज़र्वर ऑब्जेक्ट पास करने का विकल्प होता है. onSnapshot को कॉल करने पर, लौटाए जाने वाले फ़ंक्शन को कॉल करके लिसनर को रद्द किया जा सकता है.

ध्यान दें: onCompletion कॉलबैक दिया जा सकता है, लेकिन इसे कभी भी कॉल नहीं किया जाएगा, क्योंकि स्नैपशॉट स्ट्रीम कभी खत्म नहीं होती.

हस्ताक्षर:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
query	क्वेरी<AppModelType, DbModelType>	वह क्वेरी जिसे सुनना है.
अगला	(स्नैपशॉट: QuerySnapshot<AppModelType, DbModelType>) => अमान्य	नया QuerySnapshot उपलब्ध होने पर, हर बार कॉलबैक किया जाता है.
ऑन एरर	(गड़बड़ी: FirestoreError) => अमान्य	अगर कार्रवाई नहीं हो पाती या रद्द हो जाती है, तो कॉलबैक किया जाता है. इसके बाद कोई कॉलबैक नहीं होगा.
पूरा होने पर	() => अमान्य	उपलब्ध कराया जा सकता है. हालांकि, इसे कॉल नहीं किया जाएगा, क्योंकि स्ट्रीम कभी खत्म नहीं होती हैं.

लौटाए जाने वाले प्रॉडक्ट:

सदस्यता छोड़ें

सदस्यता छोड़ने का फ़ंक्शन, जिसे स्नैपशॉट लिसनर को रद्द करने के लिए कॉल किया जा सकता है.

onSnapshot(क्वेरी, विकल्प, onNext, onError, on संकेतों)

QuerySnapshot इवेंट के लिए लिसनर अटैच करता है. आपके पास अलग-अलग onNext और onError कॉलबैक पास करने या next और error कॉलबैक के साथ, सिंगल ऑब्ज़र्वर ऑब्जेक्ट पास करने का विकल्प होता है. onSnapshot को कॉल करने पर, लौटाए जाने वाले फ़ंक्शन को कॉल करके लिसनर को रद्द किया जा सकता है.

ध्यान दें: onCompletion कॉलबैक दिया जा सकता है, लेकिन इसे कभी भी कॉल नहीं किया जाएगा, क्योंकि स्नैपशॉट स्ट्रीम कभी खत्म नहीं होती.

हस्ताक्षर:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
query	क्वेरी<AppModelType, DbModelType>	वह क्वेरी जिसे सुनना है.
विकल्प	SnapshotListenOptions	सुनने के व्यवहार को कंट्रोल करने के विकल्प.
अगला	(स्नैपशॉट: QuerySnapshot<AppModelType, DbModelType>) => अमान्य	नया QuerySnapshot उपलब्ध होने पर, हर बार कॉलबैक किया जाता है.
ऑन एरर	(गड़बड़ी: FirestoreError) => अमान्य	अगर कार्रवाई नहीं हो पाती या रद्द हो जाती है, तो कॉलबैक किया जाता है. इसके बाद कोई कॉलबैक नहीं होगा.
पूरा होने पर	() => अमान्य	उपलब्ध कराया जा सकता है. हालांकि, इसे कॉल नहीं किया जाएगा, क्योंकि स्ट्रीम कभी खत्म नहीं होती हैं.

लौटाए जाने वाले प्रॉडक्ट:

सदस्यता छोड़ें

सदस्यता छोड़ने का फ़ंक्शन, जिसे स्नैपशॉट लिसनर को रद्द करने के लिए कॉल किया जा सकता है.

क्वेरी(क्वेरी, मिश्रित फ़िल्टर, queryConstraints)

क्वेरी का एक ऐसा नया इंस्टेंस बनाता है जिसे बदला नहीं जा सकता. इसे बढ़ाया गया है. इसमें क्वेरी के अन्य कंस्ट्रेंट को भी शामिल किया जाता है.

हस्ताक्षर:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<AppModelType, DbModelType>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
query	क्वेरी<AppModelType, DbModelType>	नए कंस्ट्रेंट के लिए बेस के तौर पर इस्तेमाल करने के लिए, क्वेरी इंस्टेंस.
कंपोज़िट फ़िल्टर	QueryCompositeFilterConstraint	लागू करने के लिए, QueryCompositeFilterConstraint. and() या or() का इस्तेमाल करके, QueryCompositeFilterConstraint बनाएं.
क्वेरी कंस्ट्रेंट	QueryNonFilterConstraint[]	लागू करने के लिए, अतिरिक्त QueryNonFilterConstraint (उदाहरण के लिए, orderBy(), limit()).

लौटाए जाने वाले प्रॉडक्ट:

क्वेरी<AppModelType, DbModelType>

अपवाद

अगर किसी दिए गए क्वेरी कंस्ट्रेंट को मौजूदा या नए कंस्ट्रेंट के साथ नहीं जोड़ा जा सकता.

क्वेरी(क्वेरी, queryConstraints)

क्वेरी का एक ऐसा नया इंस्टेंस बनाता है जिसे बदला नहीं जा सकता. इसे बढ़ाया गया है. इसमें क्वेरी के अन्य कंस्ट्रेंट को भी शामिल किया जाता है.

हस्ताक्षर:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, ...queryConstraints: QueryConstraint[]): Query<AppModelType, DbModelType>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
query	क्वेरी<AppModelType, DbModelType>	नए कंस्ट्रेंट के लिए बेस के तौर पर इस्तेमाल करने के लिए, क्वेरी इंस्टेंस.
क्वेरी कंस्ट्रेंट	QueryConstraint[]	लागू करने के लिए QueryConstraint की सूची.

लौटाए जाने वाले प्रॉडक्ट:

क्वेरी<AppModelType, DbModelType>

अपवाद

अगर किसी दिए गए क्वेरी कंस्ट्रेंट को मौजूदा या नए कंस्ट्रेंट के साथ नहीं जोड़ा जा सकता.

फ़ंक्शन(queryConstraints, ...)

और(queryConstraints)

एक नया QueryCompositeFilterConstraint बनाता है, जो दिए गए फ़िल्टर कंस्ट्रेंट का कॉम्बिनेशन होता है. कॉम्बिनेशन फ़िल्टर में, कोई दस्तावेज़ तब शामिल होता है, जब वह दिए गए सभी फ़िल्टर के मुताबिक हो.

हस्ताक्षर:

export declare function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
क्वेरी कंस्ट्रेंट	QueryFilterConstraint[]	ज़रूरी नहीं. कॉम्बिनेशन के लिए, QueryFilterConstraint की सूची. इन्हें where(), or() या and() पर कॉल के साथ बनाया जाना चाहिए.

लौटाए जाने वाले प्रॉडक्ट:

QueryCompositeFilterConstraint

नया बनाया गया QueryCompositeFilterConstraint.

या(queryConstraints)

एक नया QueryCompositeFilterConstraint बनाता है, जो दिए गए फ़िल्टर कंस्ट्रेंट का डिस्ट्रिब्यूशन होता है. डिसजक्शन फ़िल्टर में कोई दस्तावेज़ तब शामिल होता है, जब वह दिए गए किसी भी फ़िल्टर की शर्तों को पूरा करता है.

हस्ताक्षर:

export declare function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
क्वेरी कंस्ट्रेंट	QueryFilterConstraint[]	ज़रूरी नहीं. डेटा को अलग करने के लिए, QueryFilterConstraint की सूची. इन्हें where(), or() या and() पर कॉल के साथ बनाया जाना चाहिए.

लौटाए जाने वाले प्रॉडक्ट:

QueryCompositeFilterConstraint

नया बनाया गया QueryCompositeFilterConstraint.

फ़ंक्शन(रेफ़रंस, ...)

addDoc(रेफ़रंस, डेटा)

दिए गए डेटा के साथ, बताए गए CollectionReference में नया दस्तावेज़ जोड़ें, इसे अपने-आप दस्तावेज़ आईडी असाइन हो जाएगा.

हस्ताक्षर:

export declare function addDoc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<DocumentReference<AppModelType, DbModelType>>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
रेफ़रंस	CollectionReference<AppModelType, DbModelType>	इस दस्तावेज़ को जोड़ने के लिए कलेक्शन का रेफ़रंस.
डेटा	WithFieldValue<AppModelType>	एक ऑब्जेक्ट, जिसमें नए दस्तावेज़ का डेटा है.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<DocumentReference<AppModelType, DbModelType>>

एक Promise को DocumentReference के साथ हल किया गया, जो बैकएंड पर लिखे जाने के बाद बनाए गए नए दस्तावेज़ पर ले जाता है (ध्यान दें कि आपके ऑफ़लाइन रहने पर यह हल नहीं होगा).

कलेक्शन(रेफ़रंस, पाथ, पाथसेगमेंट)

इससे CollectionReference इंस्टेंस मिलता है, जो बताए गए रिलेटिव पाथ पर reference के सब-कलेक्शन दिखाता है.

हस्ताक्षर:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
रेफ़रंस	CollectionReference<AppModelType, DbModelType>	किसी कलेक्शन का रेफ़रंस.
पाथ	स्ट्रिंग	कलेक्शन के लिए स्लैश से अलग किया गया पाथ.
पथ सेगमेंट	स्ट्रिंग[]	पहले आर्ग्युमेंट के हिसाब से लागू किए जाने वाले अतिरिक्त पाथ सेगमेंट.

लौटाए जाने वाले प्रॉडक्ट:

CollectionReference<DocumentData, DocumentData>

CollectionReference इंस्टेंस.

अपवाद

अगर फ़ाइनल पाथ में सेगमेंट की संख्या बराबर है और यह कलेक्शन पर ले नहीं जाता.

कलेक्शन(रेफ़रंस, पाथ, पाथसेगमेंट)

इससे CollectionReference इंस्टेंस मिलता है, जो बताए गए रिलेटिव पाथ पर reference के सब-कलेक्शन दिखाता है.

हस्ताक्षर:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
रेफ़रंस	DocumentReference<AppModelType, DbModelType>	Firestore दस्तावेज़ का रेफ़रंस.
पाथ	स्ट्रिंग	कलेक्शन के लिए स्लैश से अलग किया गया पाथ.
पथ सेगमेंट	स्ट्रिंग[]	पहले आर्ग्युमेंट के हिसाब से लागू किए जाने वाले अतिरिक्त पाथ सेगमेंट.

लौटाए जाने वाले प्रॉडक्ट:

CollectionReference<DocumentData, DocumentData>

CollectionReference इंस्टेंस.

अपवाद

अगर फ़ाइनल पाथ में सेगमेंट की संख्या बराबर है और यह कलेक्शन पर ले नहीं जाता.

DeleteDoc(संदर्भ)

तय किए गए DocumentReference के ज़रिए रेफ़र किया गया दस्तावेज़ मिटाता है.

हस्ताक्षर:

export declare function deleteDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
रेफ़रंस	DocumentReference<AppModelType, DbModelType>	मिटाने के लिए, दस्तावेज़ का रेफ़रंस.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<void>

बैकएंड से दस्तावेज़ को मिटाने के बाद, प्रॉमिस रिज़ॉल्व हो जाएगा. ध्यान दें कि ऑफ़लाइन होने पर यह प्रॉमिस रिज़ॉल्व नहीं होगा.

दस्तावेज़(reference, पाथ, pathsegments)

इससे ऐसा DocumentReference इंस्टेंस मिलता है जो बताए गए रिलेटिव पाथ पर reference में मौजूद किसी दस्तावेज़ के बारे में बताता है. अगर कोई पाथ नहीं डाला गया है, तो लौटाए गए DocumentReference के लिए, अपने-आप जनरेट होने वाले यूनीक आईडी का इस्तेमाल किया जाएगा.

हस्ताक्षर:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path?: string, ...pathSegments: string[]): DocumentReference<AppModelType, DbModelType>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
रेफ़रंस	CollectionReference<AppModelType, DbModelType>	किसी कलेक्शन का रेफ़रंस.
पाथ	स्ट्रिंग	दस्तावेज़ के लिए स्लैश से अलग किया गया पाथ. अपने-आप जनरेट होने वाले आईडी का इस्तेमाल करने के लिए, इसे हटाना ज़रूरी है.
पथ सेगमेंट	स्ट्रिंग[]	पहले आर्ग्युमेंट के हिसाब से लागू किए जाने वाले अतिरिक्त पाथ सेगमेंट.

लौटाए जाने वाले प्रॉडक्ट:

DocumentReference<AppModelType, DbModelType>

DocumentReference इंस्टेंस.

अपवाद

अगर आखिरी पाथ में सेगमेंट की संख्या विषम है और वह किसी दस्तावेज़ पर ले जाता है.

दस्तावेज़(reference, पाथ, pathsegments)

इससे ऐसा DocumentReference इंस्टेंस मिलता है जो बताए गए रिलेटिव पाथ पर reference में मौजूद किसी दस्तावेज़ के बारे में बताता है.

हस्ताक्षर:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
रेफ़रंस	DocumentReference<AppModelType, DbModelType>	Firestore दस्तावेज़ का रेफ़रंस.
पाथ	स्ट्रिंग	दस्तावेज़ के लिए स्लैश से अलग किया गया पाथ.
पथ सेगमेंट	स्ट्रिंग[]	पहले आर्ग्युमेंट के हिसाब से लागू किए जाने वाले अतिरिक्त पाथ सेगमेंट.

लौटाए जाने वाले प्रॉडक्ट:

DocumentReference<DocumentData, DocumentData>

DocumentReference इंस्टेंस.

अपवाद

अगर आखिरी पाथ में सेगमेंट की संख्या विषम है और वह किसी दस्तावेज़ पर ले जाता है.

getDoc(संदर्भ)

इस DocumentReference के बताए गए दस्तावेज़ को पढ़ता है.

ध्यान दें: getDoc(), जब भी मुमकिन हो, सर्वर से डेटा मिलने का इंतज़ार करके अप-टू-डेट डेटा उपलब्ध कराने की कोशिश करता है. हालांकि, यह कैश मेमोरी में सेव किया गया डेटा वापस कर सकता है. इसके अलावा, अगर आप ऑफ़लाइन हैं और सर्वर से कनेक्ट नहीं किया जा सकता, तो भी यह प्रोसेस बंद हो सकता है. इस व्यवहार के बारे में बताने के लिए, getDocFromcache() या getDocFromServer() को शुरू करें.

हस्ताक्षर:

export declare function getDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
रेफ़रंस	DocumentReference<AppModelType, DbModelType>	फ़ेच किए जाने वाले दस्तावेज़ का रेफ़रंस.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<DocumentSnapshot<AppModelType, DbModelType>>

दस्तावेज़ में मौजूदा कॉन्टेंट को शामिल करके, DocumentSnapshot से प्रॉमिस रिज़ॉल्व किया गया.

getDocFromकैश(संदर्भ)

इस DocumentReference के बताए गए दस्तावेज़ को कैश मेमोरी से पढ़ता है. अगर दस्तावेज़ को फ़िलहाल कैश मेमोरी में सेव नहीं किया गया है, तो यह गड़बड़ी दिखाता है.

हस्ताक्षर:

export declare function getDocFromCache<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
रेफ़रंस	DocumentReference<AppModelType, DbModelType>

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<DocumentSnapshot<AppModelType, DbModelType>>

Promise को बंद करने के बाद, DocumentSnapshot में दस्तावेज़ का मौजूदा कॉन्टेंट शामिल हुआ.

getDocFromServer(संदर्भ)

इस DocumentReference के बताए गए दस्तावेज़ को सर्वर से पढ़ता है. नेटवर्क उपलब्ध न होने पर गड़बड़ी का मैसेज दिखाता है.

हस्ताक्षर:

export declare function getDocFromServer<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
रेफ़रंस	DocumentReference<AppModelType, DbModelType>

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<DocumentSnapshot<AppModelType, DbModelType>>

Promise को बंद करने के बाद, DocumentSnapshot में दस्तावेज़ का मौजूदा कॉन्टेंट शामिल हुआ.

onSnapshot(रेफ़रंस, ऑब्ज़र्वर)

DocumentSnapshot इवेंट के लिए लिसनर अटैच करता है. आपके पास अलग-अलग onNext और onError कॉलबैक पास करने या next और error कॉलबैक के साथ, सिंगल ऑब्ज़र्वर ऑब्जेक्ट पास करने का विकल्प होता है.

ध्यान दें: onCompletion कॉलबैक दिया जा सकता है, लेकिन इसे कभी भी कॉल नहीं किया जाएगा, क्योंकि स्नैपशॉट स्ट्रीम कभी खत्म नहीं होती.

हस्ताक्षर:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
रेफ़रंस	DocumentReference<AppModelType, DbModelType>	सुनने के लिए दस्तावेज़ का रेफ़रंस.
ऑब्ज़र्वर	{ आगे बढ़ें?: (स्नैपशॉट: DocumentSnapshot<AppModelType, DbModelType>) => अमान्य; गड़बड़ी?: (गड़बड़ी: FirestoreError) => अमान्य; पूरा हुआ?: () => अमान्य; } पर स्विच करने के मकसद से, हमसे संपर्क करने के लिए धन्यवाद.	एक ऑब्जेक्ट जिसमें next और error कॉलबैक होते हैं.

लौटाए जाने वाले प्रॉडक्ट:

सदस्यता छोड़ें

सदस्यता छोड़ने का फ़ंक्शन, जिसे स्नैपशॉट लिसनर को रद्द करने के लिए कॉल किया जा सकता है.

onSnapshot(रेफ़रंस, विकल्प, ऑब्ज़र्वर)

DocumentSnapshot इवेंट के लिए लिसनर अटैच करता है. आपके पास अलग-अलग onNext और onError कॉलबैक पास करने या next और error कॉलबैक के साथ, सिंगल ऑब्ज़र्वर ऑब्जेक्ट पास करने का विकल्प होता है.

ध्यान दें: onCompletion कॉलबैक दिया जा सकता है, लेकिन इसे कभी भी कॉल नहीं किया जाएगा, क्योंकि स्नैपशॉट स्ट्रीम कभी खत्म नहीं होती.

हस्ताक्षर:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
रेफ़रंस	DocumentReference<AppModelType, DbModelType>	सुनने के लिए दस्तावेज़ का रेफ़रंस.
विकल्प	SnapshotListenOptions	सुनने के व्यवहार को कंट्रोल करने के विकल्प.
ऑब्ज़र्वर	{ आगे बढ़ें?: (स्नैपशॉट: DocumentSnapshot<AppModelType, DbModelType>) => अमान्य; गड़बड़ी?: (गड़बड़ी: FirestoreError) => अमान्य; पूरा हुआ?: () => अमान्य; } पर स्विच करने के मकसद से, हमसे संपर्क करने के लिए धन्यवाद.	एक ऑब्जेक्ट जिसमें next और error कॉलबैक होते हैं.

लौटाए जाने वाले प्रॉडक्ट:

सदस्यता छोड़ें

सदस्यता छोड़ने का फ़ंक्शन, जिसे स्नैपशॉट लिसनर को रद्द करने के लिए कॉल किया जा सकता है.

onSnapshot(reference, onNext, onError, oncomplete)

DocumentSnapshot इवेंट के लिए लिसनर अटैच करता है. आपके पास अलग-अलग onNext और onError कॉलबैक पास करने या next और error कॉलबैक के साथ, सिंगल ऑब्ज़र्वर ऑब्जेक्ट पास करने का विकल्प होता है.

ध्यान दें: onCompletion कॉलबैक दिया जा सकता है, लेकिन इसे कभी भी कॉल नहीं किया जाएगा, क्योंकि स्नैपशॉट स्ट्रीम कभी खत्म नहीं होती.

हस्ताक्षर:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
रेफ़रंस	DocumentReference<AppModelType, DbModelType>	सुनने के लिए दस्तावेज़ का रेफ़रंस.
अगला	(स्नैपशॉट: DocumentSnapshot<AppModelType, DbModelType>) => अमान्य	नया DocumentSnapshot उपलब्ध होने पर, हर बार कॉलबैक किया जाता है.
ऑन एरर	(गड़बड़ी: FirestoreError) => अमान्य	अगर कार्रवाई नहीं हो पाती या रद्द हो जाती है, तो कॉलबैक किया जाता है. इसके बाद कोई कॉलबैक नहीं होगा.
पूरा होने पर	() => अमान्य	उपलब्ध कराया जा सकता है. हालांकि, इसे कॉल नहीं किया जाएगा, क्योंकि स्ट्रीम कभी खत्म नहीं होती हैं.

लौटाए जाने वाले प्रॉडक्ट:

सदस्यता छोड़ें

सदस्यता छोड़ने का फ़ंक्शन, जिसे स्नैपशॉट लिसनर को रद्द करने के लिए कॉल किया जा सकता है.

onSnapshot(reference, options, onNext, onError, oncomplete)

DocumentSnapshot इवेंट के लिए लिसनर अटैच करता है. आपके पास अलग-अलग onNext और onError कॉलबैक पास करने या next और error कॉलबैक के साथ, सिंगल ऑब्ज़र्वर ऑब्जेक्ट पास करने का विकल्प होता है.

ध्यान दें: onCompletion कॉलबैक दिया जा सकता है, लेकिन इसे कभी भी कॉल नहीं किया जाएगा, क्योंकि स्नैपशॉट स्ट्रीम कभी खत्म नहीं होती.

हस्ताक्षर:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
रेफ़रंस	DocumentReference<AppModelType, DbModelType>	सुनने के लिए दस्तावेज़ का रेफ़रंस.
विकल्प	SnapshotListenOptions	सुनने के व्यवहार को कंट्रोल करने के विकल्प.
अगला	(स्नैपशॉट: DocumentSnapshot<AppModelType, DbModelType>) => अमान्य	नया DocumentSnapshot उपलब्ध होने पर, हर बार कॉलबैक किया जाता है.
ऑन एरर	(गड़बड़ी: FirestoreError) => अमान्य	अगर कार्रवाई नहीं हो पाती या रद्द हो जाती है, तो कॉलबैक किया जाता है. इसके बाद कोई कॉलबैक नहीं होगा.
पूरा होने पर	() => अमान्य	उपलब्ध कराया जा सकता है. हालांकि, इसे कॉल नहीं किया जाएगा, क्योंकि स्ट्रीम कभी खत्म नहीं होती हैं.

लौटाए जाने वाले प्रॉडक्ट:

सदस्यता छोड़ें

सदस्यता छोड़ने का फ़ंक्शन, जिसे स्नैपशॉट लिसनर को रद्द करने के लिए कॉल किया जा सकता है.

setDoc(रेफ़रंस, डेटा)

इस DocumentReference के बताए गए दस्तावेज़ में लिखा जाता है. अगर दस्तावेज़ अब तक मौजूद नहीं है, तो इसे बना दिया जाएगा.

हस्ताक्षर:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
रेफ़रंस	DocumentReference<AppModelType, DbModelType>	लिखने के लिए दस्तावेज़ का रेफ़रंस.
डेटा	WithFieldValue<AppModelType>	दस्तावेज़ के फ़ील्ड और वैल्यू का मैप.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<void>

बैकएंड में डेटा सही तरीके से लिख लेने के बाद, Promise का समाधान हो जाता है (ध्यान दें कि ऑफ़लाइन रहने पर यह ठीक नहीं होगा).

setDoc(रेफ़रंस, डेटा, विकल्प)

तय किए गए DocumentReference के बताए गए दस्तावेज़ में लिखता है. अगर दस्तावेज़ अब तक मौजूद नहीं है, तो इसे बना दिया जाएगा. merge या mergeFields देने पर, दिए गए डेटा को किसी मौजूदा दस्तावेज़ में मर्ज किया जा सकता है.

हस्ताक्षर:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
रेफ़रंस	DocumentReference<AppModelType, DbModelType>	लिखने के लिए दस्तावेज़ का रेफ़रंस.
डेटा	PartialWithFieldValue<AppModelType>	दस्तावेज़ के फ़ील्ड और वैल्यू का मैप.
विकल्प	SetOptions	सेट किए गए व्यवहार को कॉन्फ़िगर करने के लिए ऑब्जेक्ट.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<void>

बैकएंड में डेटा सही तरीके से लिखे जाने के बाद, प्रॉमिस रिज़ॉल्व हो जाएगा. ध्यान दें कि ऑफ़लाइन होने पर यह प्रॉमिस रिज़ॉल्व नहीं होगा.

updatedDoc(रेफ़रंस, डेटा)

DocumentReference के बताए गए दस्तावेज़ में फ़ील्ड अपडेट करता है. अगर किसी ऐसे दस्तावेज़ पर लागू किया जाता है जो मौजूद नहीं है, तो अपडेट पूरा नहीं होगा.

हस्ताक्षर:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
रेफ़रंस	DocumentReference<AppModelType, DbModelType>	अपडेट किए जाने वाले दस्तावेज़ का रेफ़रंस.
डेटा	UpdateData<DbModelType>	एक ऑब्जेक्ट, जिसमें वे फ़ील्ड और वैल्यू हैं जिनकी मदद से दस्तावेज़ को अपडेट किया जाना है. फ़ील्ड में दस्तावेज़ में नेस्ट किए गए फ़ील्ड का रेफ़रंस देने के लिए बिंदु हो सकते हैं.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<void>

बैकएंड में डेटा सही तरीके से लिख लेने के बाद, Promise का समाधान हो जाता है (ध्यान दें कि ऑफ़लाइन रहने पर यह ठीक नहीं होगा).

updatedDoc(रेफ़रंस, फ़ील्ड, वैल्यू, moreFieldsAndValues)

बताए गए दस्तावेज़ में DocumentReference के बताए गए फ़ील्ड अपडेट करता है. अगर किसी ऐसे दस्तावेज़ पर लागू किया गया है जो मौजूद नहीं है, तो अपडेट पूरा नहीं होगा.

बिंदु से अलग किए गए फ़ील्ड पाथ की स्ट्रिंग देकर या FieldPath ऑब्जेक्ट देकर, नेस्ट किए गए फ़ील्ड को अपडेट किया जा सकता है.

हस्ताक्षर:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
रेफ़रंस	DocumentReference<AppModelType, DbModelType>	अपडेट किए जाने वाले दस्तावेज़ का रेफ़रंस.
फ़ील्ड	स्ट्रिंग | FieldPath	अपडेट किया जाने वाला पहला फ़ील्ड.
value	अज्ञात	पहली वैल्यू.
ज़्यादा फ़ील्ड और वैल्यू	अज्ञात[]	की-वैल्यू के अन्य पेयर.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<void>

बैकएंड में डेटा सही तरीके से लिख लेने के बाद, Promise का समाधान हो जाता है (ध्यान दें कि ऑफ़लाइन रहने पर यह ठीक नहीं होगा).

फ़ंक्शन(सेटिंग, ...)

मेमोरीलोकल कैश(सेटिंग)

MemoryLocalCache का इंस्टेंस बनाता है. SDK टूल को यह बताने के लिए कि किस कैश लेयर का इस्तेमाल करना है, इंस्टेंस को FirestoreSettings.cache पर सेट किया जा सकता है.

हस्ताक्षर:

export declare function memoryLocalCache(settings?: MemoryCacheSettings): MemoryLocalCache;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
सेटिंग	Memoryकैशसेटिंग

लौटाए जाने वाले प्रॉडक्ट:

MemoryLocal कैश

मेमोरीLruGarbageCollector(सेटिंग)

MemoryLruGarbageCollector का इंस्टेंस बनाता है.

टारगेट के साइज़ को सेटिंग पैरामीटर के हिस्से के तौर पर तय किया जा सकता है. कैश मेमोरी का साइज़ तय किए गए साइज़ से ज़्यादा होने पर, कलेक्टर दस्तावेज़ों को मिटाना शुरू कर देगा. कैश मेमोरी का डिफ़ॉल्ट साइज़ 40 एमबी (40 * 1024 * 1024 बाइट) होता है.

हस्ताक्षर:

export declare function memoryLruGarbageCollector(settings?: {
    cacheSizeBytes?: number;
}): MemoryLruGarbageCollector;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
सेटिंग	{ cacheSizeBytes?: नंबर; } पर स्विच करने के मकसद से, हमसे संपर्क करने के लिए धन्यवाद.

लौटाए जाने वाले प्रॉडक्ट:

MemoryLruGarbageCollector

परसिस्टेंटलोकल कैश(सेटिंग)

PersistentLocalCache का इंस्टेंस बनाता है. SDK टूल को यह बताने के लिए कि किस कैश लेयर का इस्तेमाल करना है, इंस्टेंस को FirestoreSettings.cache पर सेट किया जा सकता है.

Node.js के साथ स्थायी कैश मेमोरी का इस्तेमाल नहीं किया जा सकता.

हस्ताक्षर:

export declare function persistentLocalCache(settings?: PersistentCacheSettings): PersistentLocalCache;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
सेटिंग	परसिस्टेंट कैश सेटिंग

लौटाए जाने वाले प्रॉडक्ट:

परसिस्टेंट लोकल कैश

परसिस्टेंट सिंगलटैबमैनेजर(सेटिंग)

PersistentSingleTabManager का इंस्टेंस बनाता है.

हस्ताक्षर:

export declare function persistentSingleTabManager(settings: PersistentSingleTabManagerSettings | undefined): PersistentSingleTabManager;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
सेटिंग	PersistentSingleTabManagerSettings | तय नहीं है	यह नीति, बनाए गए टैब मैनेजर को कॉन्फ़िगर करती है.

लौटाए जाने वाले प्रॉडक्ट:

PersistentSingleTabManager

फ़ंक्शन(स्नैपशॉट, ...)

endAt(स्नैपशॉट)

एक ऐसा QueryEndAtConstraint बनाता है जो नतीजे के सेट को दिए गए दस्तावेज़ पर खत्म होने के लिए बदलता है (शामिल है). खत्म होने की पोज़िशन, क्वेरी के क्रम के हिसाब से होती है. दस्तावेज़ में वे सभी फ़ील्ड होने चाहिए जो क्वेरी के orderBy में दिए गए हों.

हस्ताक्षर:

export declare function endAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
स्नैपशॉट	DocumentSnapshot<AppModelType, DbModelType>	खत्म होने के लिए दस्तावेज़ का स्नैपशॉट.

लौटाए जाने वाले प्रॉडक्ट:

QueryEndAtConstraint

query() को पास करने के लिए एक QueryEndAtConstraint

end before(स्नैपशॉट)

एक ऐसा QueryEndAtConstraint बनाता है जो नतीजे के सेट को दिए गए दस्तावेज़ (खास तौर पर) से पहले खत्म होने के लिए सेट करता है. खत्म होने की पोज़िशन, क्वेरी के क्रम के हिसाब से होती है. दस्तावेज़ में वे सभी फ़ील्ड होने चाहिए जो क्वेरी के orderBy में दिए गए हों.

हस्ताक्षर:

export declare function endBefore<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
स्नैपशॉट	DocumentSnapshot<AppModelType, DbModelType>	इससे पहले खत्म होने के लिए दस्तावेज़ का स्नैपशॉट.

लौटाए जाने वाले प्रॉडक्ट:

QueryEndAtConstraint

query() को पास करने के लिए एक QueryEndAtConstraint

शुरू के बाद(स्नैपशॉट)

एक QueryStartAtConstraint बनाता है, जो दिए गए दस्तावेज़ (खास तौर पर) के बाद शुरू होने के लिए नतीजे सेट को बदलता है. शुरुआती स्थिति क्वेरी के क्रम के हिसाब से होती है. दस्तावेज़ में वे सभी फ़ील्ड होने चाहिए जो क्वेरी के orderBy में दिए गए हों.

हस्ताक्षर:

export declare function startAfter<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
स्नैपशॉट	DocumentSnapshot<AppModelType, DbModelType>	बाद में शुरू होने वाले दस्तावेज़ का स्नैपशॉट.

लौटाए जाने वाले प्रॉडक्ट:

QueryStartAtConstraint

query() को पास करने के लिए, एक QueryStartAtConstraint

शुरू करें(स्नैपशॉट)

यह एक QueryStartAtConstraint बनाता है, जो दिए गए दस्तावेज़ से शुरू होने वाले नतीजे के सेट में बदलाव करता है, ताकि उसे दिए गए दस्तावेज़ से जोड़ा जा सके. शुरुआती स्थिति क्वेरी के क्रम के हिसाब से होती है. दस्तावेज़ में इस क्वेरी के orderBy में दिए गए सभी फ़ील्ड शामिल होने चाहिए.

हस्ताक्षर:

export declare function startAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
स्नैपशॉट	DocumentSnapshot<AppModelType, DbModelType>	शुरू होने के लिए दस्तावेज़ का स्नैपशॉट.

लौटाए जाने वाले प्रॉडक्ट:

QueryStartAtConstraint

query() पर जाने के लिए एक QueryStartAtConstraint.

फ़ंक्शन(वैल्यू, ...)

वेक्टर(वैल्यू)

संख्याओं के दिए गए कलेक्शन की कॉपी से नया VectorValue बनाता है.

हस्ताक्षर:

export declare function vector(values?: number[]): VectorValue;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
मान	नंबर[]	संख्याओं के इस कलेक्शन की कॉपी के साथ VectorValue इंस्टेंस बनाएं.

लौटाए जाने वाले प्रॉडक्ट:

वेक्टरवैल्यू

संख्याओं के दिए गए कलेक्शन की कॉपी से बनाया गया नया VectorValue.

CACHE_SIZE_ स्टोर

एलआरयू गार्बेज कलेक्शन को बंद करने के लिए इस्तेमाल किया जाने वाला कॉन्सटेंट. Firestore इंस्टेंस को दी गई सेटिंग पर, इस वैल्यू को cacheSizeBytes के तौर पर सेट करें.

हस्ताक्षर:

CACHE_SIZE_UNLIMITED = -1

PrefixToKeys

एक नया मैप दिखाता है, जहां हर कुंजी के शुरू में बाहरी कुंजी को बिंदु से जोड़ा जाता है.

हस्ताक्षर:

export declare type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
    [K in keyof T & string as `${Prefix}.${K}`]+?: string extends K ? any : T[K];
};

एग्रीगेट फ़ील्ड टाइप

सभी AggregateField टाइप जो Firestore के साथ काम करते हैं उनका कॉम्बिनेशन.

हस्ताक्षर:

export declare type AggregateFieldType = ReturnType<typeof sum> | ReturnType<typeof average> | ReturnType<typeof count>;

एग्रीगेटस्पेक्टडेटा

ऐसा टाइप जिसकी कुंजियां AggregateSpec से ली जाती हैं और जिनकी वैल्यू, इनपुट AggregateSpec से लिए गए AggregateField के एग्रीगेशन का नतीजा होती हैं.

हस्ताक्षर:

export declare type AggregateSpecData<T extends AggregateSpec> = {
    [P in keyof T]: T[P] extends AggregateField<infer U> ? U : never;
};

एग्रीगेट टाइप

यूनियन टाइप, जो परफ़ॉर्म किए जाने वाले एग्रीगेट टाइप को दिखाता है.

हस्ताक्षर:

export declare type AggregateType = 'count' | 'avg' | 'sum';

चाइल्डअपडेट फ़ील्ड

दिए गए टाइप T1 के लिए, नेस्ट किए गए फ़ील्ड का हिसाब लगाने में मदद करने वाला टूल. undefined | {...} (वैकल्पिक प्रॉपर्टी के लिए होता है) या {a: A} | {b: B} जैसे यूनियन टाइप के डिस्ट्रिब्यूशन के लिए इसकी ज़रूरत होती है.

इस्तेमाल के इस उदाहरण में, Record को T[K] के यूनियन टाइप को बांटने के लिए V का इस्तेमाल किया जाता है, क्योंकि T[K] का आकलन एक्सप्रेशन के तौर पर किया जाता है, न कि इसे बांटा जाता है.

https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types देखें

हस्ताक्षर:

export declare type ChildUpdateFields<K extends string, V> = V extends Record<string, unknown> ? AddPrefixToKeys<K, UpdateData<V>> : never;

दस्तावेज़ परिवर्तन प्रकार

DocumentChange का टाइप 'जोड़ा गया', 'हटाया गया' या 'बदलाव किया गया' हो सकता है.

हस्ताक्षर:

export declare type DocumentChangeType = 'added' | 'removed' | 'modified';

Firestore में हुई गड़बड़ी का कोड

Firestore स्टेटस कोड का सेट. यहां gRPC के ज़रिए दिखाए गए कोड एक जैसे हैं: https://github.com/grpc/grpc/blob/Master/doc/statuscodes.md

संभावित मान: - 'रद्द किया गया': कार्रवाई रद्द कर दी गई थी (आम तौर पर कॉलर की ओर से). - 'जानकारी नहीं है': ऐसी गड़बड़ी या किसी दूसरे गड़बड़ी डोमेन की गड़बड़ी. - 'अमान्य तर्क': क्लाइंट ने कोई अमान्य तर्क बताया है. ध्यान दें कि यह 'पहले से तय की गई शर्त' से अलग है. 'अमान्य-तर्क' यह ऐसे तर्क को दिखाता है जिनमें सिस्टम की स्थिति की परवाह किए बिना समस्या होती है (उदाहरण के लिए, किसी फ़ील्ड का अमान्य नाम). - 'समयसीमा खत्म हो गई है': कार्रवाई पूरी होने से पहले समयसीमा खत्म हो गई है. सिस्टम की स्थिति बदलने वाले ऑपरेशन के लिए, यह गड़बड़ी दिखाई जा सकती है, भले ही कार्रवाई पूरी तरह से पूरी हो गई हो. उदाहरण के लिए, हो सकता है कि सर्वर से सही जवाब मिलने में ज़्यादा समय लगे और समयसीमा खत्म होने में देरी हो. - 'नहीं मिला': अनुरोध किया गया कुछ दस्तावेज़ नहीं मिला. - 'पहले से मौजूद है': हमने जो दस्तावेज़ बनाने की कोशिश की थी वह पहले से मौजूद है. - 'अनुमति नहीं दी गई': कॉलर के पास बताए गए ऑपरेशन को लागू करने की अनुमति नहीं है. - 'संसाधन खत्म': कुछ संसाधन खत्म हो गए हैं. ऐसा शायद हर उपयोगकर्ता के लिए कोटा खत्म हो गया हो या पूरे फ़ाइल सिस्टम में जगह न बची हो. - 'पहले से तय की गई शर्त': ऑपरेशन को अस्वीकार कर दिया गया था क्योंकि सिस्टम कार्रवाई के निष्पादन के लिए ज़रूरी स्थिति में नहीं है. - 'रद्द किया गया': आम तौर पर, लेन-देन रद्द होने जैसी किसी एक साथ काम करने की समस्या की वजह से कार्रवाई रद्द कर दी जाती है. - 'सीमा से बाहर': सही सीमा से बाहर जाने की कोशिश की गई. - 'लागू नहीं है': ऑपरेशन लागू नहीं किया गया है या काम नहीं करता/चालू नहीं है. - 'इंटरनल': अंदरूनी गड़बड़ियां. इसका मतलब है कि मौजूदा सिस्टम से उम्मीद के मुताबिक कुछ इन्वैरिएंट काम नहीं कर रहे हैं. अगर आपको इनमें से कोई एक गड़बड़ी दिखती है, तो इसका मतलब है कि कुछ ठीक से काम नहीं कर रहा है. - 'उपलब्ध नहीं है': यह सेवा फ़िलहाल उपलब्ध नहीं है. यह स्थिति थोड़े समय के लिए होती है और इसे ठीक करने के लिए, बैकऑफ़ के साथ फिर से कोशिश करें. - 'डेटा-लॉस': डेटा को वापस नहीं पाया जा सकता या खराब हो गया. - 'अप्रमाणित': कार्रवाई के लिए अनुरोध में मान्य प्रमाणीकरण क्रेडेंशियल नहीं हैं.

हस्ताक्षर:

export declare type FirestoreErrorCode = 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';

FirestoreLocalकैश

काम करने वाले सभी SDK टूल की कैश लेयर से यूनियन टाइप.

हस्ताक्षर:

export declare type FirestoreLocalCache = MemoryLocalCache | PersistentLocalCache;

लिसनसोर्स

उस सोर्स के बारे में बताएं जिसे क्वेरी सुन रही है.

कैश मेमोरी और सर्वर में हुए बदलाव, दोनों को सुनने के लिए, default पर सेट करें. सिर्फ़ कैश मेमोरी में हुए बदलावों को सुनने के लिए, cache पर सेट करें.

हस्ताक्षर:

export declare type ListenSource = 'default' | 'cache';

मेमोरीगारबेजकलेक्टर

मेमोरी लोकल कैश के लिए, सपोर्ट करने वाले गार्बेज कलेक्टर से यूनियन टाइप.

हस्ताक्षर:

export declare type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;

NestedUpdateFields

हर फ़ील्ड (जैसे कि 'बार') के लिए, नेस्ट की गई सभी कुंजियां ढूंढें (उदाहरण के लिए, {'bar.baz': T1, 'bar.QUx': T2}). उन्हें एक साथ काटकर एक ऐसा मैप बनाएं जिसमें 'ज़रूरी नहीं' के तौर पर मार्क की गई सभी संभावित कुंजियां हों

हस्ताक्षर:

export declare type NestedUpdateFields<T extends Record<string, unknown>> = UnionToIntersection<{
    [K in keyof T & string]: ChildUpdateFields<K, T[K]>;
}[keyof T & string]>;

OrderByDirection

orderBy() क्लॉज़ की दिशा 'ब्यौरा' के तौर पर बताई गई है या 'बढ़ते क्रम में' (घटते क्रम में या बढ़ते क्रम में).

हस्ताक्षर:

export declare type OrderByDirection = 'desc' | 'asc';

PartialWithFieldValue

यह TypeScript के Partial<T> की तरह है. हालांकि, इसमें नेस्ट किए गए फ़ील्ड को प्रॉपर्टी के मान के तौर पर पास करने औरFieldValues को पास करने की अनुमति होती है.

हस्ताक्षर:

export declare type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: PartialWithFieldValue<T[K]> | FieldValue;
} : never);

PersistentTabManager

सभी उपलब्ध टैब मैनेजर का यूनियन.

हस्ताक्षर:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

प्रिमिटिव

प्रिमिटिव टाइप.

हस्ताक्षर:

export declare type Primitive = string | number | boolean | undefined | null;

क्वेरीConstraintType

इस SDK टूल में उपलब्ध अलग-अलग क्वेरी कंस्ट्रेंट के बारे में बताता है.

हस्ताक्षर:

export declare type QueryConstraintType = 'where' | 'orderBy' | 'limit' | 'limitToLast' | 'startAt' | 'startAfter' | 'endAt' | 'endBefore';

क्वेरीफ़िल्टर प्रतिबंध

QueryFilterConstraint एक हेल्पर यूनियन टाइप है, जो QueryFieldFilterConstraint और QueryCompositeFilterConstraint को दिखाता है.

हस्ताक्षर:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

क्वेरीNonFilterConstraint

QueryNonFilterConstraint एक हेल्पर यूनियन टाइप है, जो QueryConstraints को दिखाता है, जिनका इस्तेमाल दस्तावेज़ों के सेट को छोटा करने या क्रम से लगाने के लिए किया जाता है. हालांकि, यह दस्तावेज़ के फ़ील्ड पर साफ़ तौर पर फ़िल्टर नहीं करता है. QueryNonFilterConstraint को orderBy(), startAt(), startAfter(), endbefore(), endAt(), limit() या limitToLast() को लागू करके बनाया जाता है. इसके बाद, इसे query() में पास किया जा सकता है.QueryConstraint

हस्ताक्षर:

export declare type QueryNonFilterConstraint = QueryOrderByConstraint | QueryLimitConstraint | QueryStartAtConstraint | QueryEndAtConstraint;

विकल्प सेट करें

एक विकल्प ऑब्जेक्ट, जो setDoc() और कॉल के व्यवहार को कॉन्फ़िगर करता है. इन कॉल को merge: true के साथ SetOptions देकर, टारगेट दस्तावेज़ों को ओवरराइट करने के बजाय, पूरी तरह से मर्ज करने के लिए कॉन्फ़िगर किया जा सकता है.

हस्ताक्षर:

export declare type SetOptions = {
    readonly merge?: boolean;
} | {
    readonly mergeFields?: Array<string | FieldPath>;
};

टास्कस्टेट

इससे बंडल लोड होने वाले टास्क की स्थिति के बारे में पता चलता है.

दोनों 'गड़बड़ी' और 'सफलता' मिले सिंक हो रहा है: टास्क रद्द हो जाएगा या पूरा हो जाएगा. इसके बाद, टास्क को रिपोर्ट करने के बाद कोई अपडेट नहीं होगा.

हस्ताक्षर:

export declare type TaskState = 'Error' | 'Running' | 'Success';

यूनियन टू इंटरसेक्शन

यूनियन टाइप U = T1 | T2 | ... दिए जाने पर, इंटरसेक्टेड टाइप (T1 & T2 & ...) लौटाता है.

कंडिशनल टाइप की कंडिशनल टाइप और कंडिशनल टाइप के अनुमान का इस्तेमाल करता है. यह इसलिए काम करता है, क्योंकि कॉन्ट्रा-वैरिएंट पोज़िशन में एक ही टाइप वैरिएबल के लिए कई कैंडिडेट होते हैं. इसकी वजह से, इंटरसेक्शन का अनुमान लगाया जाता है. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection-type

हस्ताक्षर:

export declare type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;

डेटा अपडेट करें

updateDoc() के साथ इस्तेमाल करने के लिए डेटा अपडेट करें. इसमें वैल्यू के लिए मैप किए गए फ़ील्ड पाथ (जैसे कि 'foo' या 'foo.baz') शामिल हैं. जिन फ़ील्ड में बिंदु होते हैं वे दस्तावेज़ में नेस्ट किए गए फ़ील्ड का रेफ़रंस देते हैं. फ़ील्ड वैल्यू को प्रॉपर्टी की वैल्यू के तौर पर पास किया जा सकता है.

हस्ताक्षर:

export declare type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: UpdateData<T[K]> | FieldValue;
} & NestedUpdateFields<T> : Partial<T>;

व्हिफ़िल्टरऑप

where() क्लॉज़ में फ़िल्टर की शर्तों को '&lt;', '&lt;=', '==', '!=', '&gt;=', '&gt;', 'array-contains', 'in', 'array-contains-any', और 'not-in' स्ट्रिंग का इस्तेमाल करके तय किया जाता है.

हस्ताक्षर:

export declare type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-contains' | 'in' | 'array-contains-any' | 'not-in';

फ़ील्ड के साथ वैल्यू

प्रकार सुरक्षा बनाए रखते हुए, फ़ील्ड वैल्यू को प्रॉपर्टी मान के रूप में पास करने की अनुमति देता है.

हस्ताक्षर:

export declare type WithFieldValue<T> = T | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]: WithFieldValue<T[K]> | FieldValue;
} : never);