आपके क्लाउड फायरस्टोर इंस्टेंस के लिए कस्टम कॉन्फ़िगरेशन निर्दिष्ट करता है। किसी भी अन्य तरीके को लागू करने से पहले आपको इन्हें सेट करना होगा।
हस्ताक्षर:
export declare interface FirestoreSettings
गुण
| संपत्ति | प्रकार | विवरण |
|---|---|---|
| कैश आकार बाइट्स | संख्या | ध्यान दें: इस फ़ील्ड को भविष्य की प्रमुख रिलीज़ में हटा दिया जाएगा। कैश आकार और अन्य कैश कॉन्फ़िगरेशन निर्दिष्ट करने के लिए इसके बजाय cache फ़ील्ड का उपयोग करें। ऑन-डिस्क डेटा के लिए अनुमानित कैश आकार सीमा। यदि कैश इस आकार से अधिक बढ़ता है, तो फायरस्टोर उस डेटा को हटाना शुरू कर देगा जिसका हाल ही में उपयोग नहीं किया गया है। आकार इस बात की गारंटी नहीं है कि कैश उस आकार से नीचे रहेगा, केवल यह कि यदि कैश दिए गए आकार से अधिक है, तो सफाई का प्रयास किया जाएगा। डिफ़ॉल्ट मान 40 एमबी है. सीमा को कम से कम 1 एमबी पर सेट किया जाना चाहिए, और कचरा संग्रहण को अक्षम करने के लिए इसे CACHE_SIZE_UNLIMITED पर सेट किया जा सकता है। |
| प्रयोगात्मकऑटोडिटेक्टलॉन्गपोलिंग | बूलियन | एसडीके के अंतर्निहित ट्रांसपोर्ट (वेबचैनल) को स्वचालित रूप से यह पता लगाने के लिए कॉन्फ़िगर करता है कि क्या लॉन्ग-पोलिंग का उपयोग किया जाना चाहिए। यह experimentalForceLongPolling के समान है, लेकिन यदि आवश्यक हो तो केवल लंबे मतदान का उपयोग करता है। 2019 में अपनी स्थापना के बाद से false का डिफ़ॉल्ट मान होने के बाद, इस सेटिंग का डिफ़ॉल्ट मान मई 2023 में फायरबेस जावास्क्रिप्ट एसडीके के v9.22.0 में true में बदल दिया गया था। यानी, लंबी पोलिंग का ऑटो-डिटेक्शन अब डिफ़ॉल्ट रूप से सक्षम है। इसे अक्षम करने के लिए, इस सेटिंग को false पर सेट करें, और कृपया उन समस्याओं को साझा करने के लिए GitHub समस्या खोलें, जिन्होंने आपको लंबे समय तक मतदान वाले ऑटो-डिटेक्शन को अक्षम करने के लिए प्रेरित किया। इस सेटिंग का उपयोग Node.js परिवेश में नहीं किया जा सकता. |
| प्रयोगात्मकफोर्सलॉन्गपोलिंग | बूलियन | एसडीके के अंतर्निहित नेटवर्क ट्रांसपोर्ट (वेबचैनल) को लॉन्ग-पोलिंग का उपयोग करने के लिए बाध्य करता है। बैकएंड से प्रत्येक प्रतिक्रिया बैकएंड द्वारा डेटा भेजने के तुरंत बाद बंद कर दी जाएगी (बैकएंड में भेजने के लिए अधिक डेटा होने की स्थिति में डिफ़ॉल्ट प्रतिक्रियाओं को खुला रखा जाता है)। यह कुछ प्रॉक्सी, एंटीवायरस सॉफ़्टवेयर इत्यादि के साथ असंगतता के मुद्दों से बचाता है जो गलत तरीके से ट्रैफ़िक को अनिश्चित काल तक बफर करते हैं। हालाँकि इस विकल्प के उपयोग से प्रदर्शन में कुछ गिरावट आएगी। इस सेटिंग का प्रयोग experimentalAutoDetectLongPolling के साथ नहीं किया जा सकता है और भविष्य में रिलीज़ में इसे हटाया जा सकता है। यदि आप स्वयं को किसी विशिष्ट नेटवर्क विश्वसनीयता समस्या के आसपास काम करने के लिए इसका उपयोग करते हुए पाते हैं, तो कृपया हमें https://github.com/firebase/firebase-js-sdk/issues/1674 में इसके बारे में बताएं। इस सेटिंग का उपयोग Node.js परिवेश में नहीं किया जा सकता. |
| प्रयोगात्मकLongPollingOptions | प्रायोगिक दीर्घमतदान विकल्प | विकल्प जो लंबे समय तक मतदान का उपयोग करने पर एसडीके के अंतर्निहित नेटवर्क ट्रांसपोर्ट (वेबचैनल) को कॉन्फ़िगर करते हैं। इन विकल्पों का उपयोग केवल तभी किया जाता है जब experimentalForceLongPolling सत्य है या यदि experimentalAutoDetectLongPolling सत्य है और ऑटो-डिटेक्शन ने निर्धारित किया है कि लंबे मतदान की आवश्यकता थी। अन्यथा, इन विकल्पों का कोई प्रभाव नहीं पड़ता. |
| मेज़बान | डोरी | कनेक्ट करने के लिए होस्टनाम. |
| अपरिभाषितगुणों को अनदेखा करें | बूलियन | क्या नेस्टेड गुणों को छोड़ना है जो ऑब्जेक्ट क्रमबद्धता के दौरान undefined पर सेट हैं। यदि true पर सेट किया जाता है, तो इन गुणों को छोड़ दिया जाता है और फायरस्टोर को नहीं लिखा जाता है। यदि false पर सेट किया जाता है या छोड़ दिया जाता है, तो SDK undefined प्रकार के गुणों का सामना करने पर एक अपवाद फेंकता है। |
| स्थानीय कैश | फायरस्टोरलोकल कैश | एसडीके द्वारा उपयोग किए गए कैश को निर्दिष्ट करता है। उपलब्ध विकल्प MemoryLocalCache और PersistentLocalCache हैं, प्रत्येक अलग कॉन्फ़िगरेशन विकल्प के साथ। अनिर्दिष्ट होने पर, MemoryLocalCache उपयोग डिफ़ॉल्ट रूप से किया जाएगा। नोट: इस फ़ील्ड और cacheSizeBytes एक ही समय में सेट करने से एसडीके आरंभीकरण के दौरान अपवाद उत्पन्न हो जाएगा। इसके बजाय, कैश आकार निर्दिष्ट करने के लिए FirestoreLocalCache ऑब्जेक्ट में कॉन्फ़िगरेशन का उपयोग करें। |
| एसएसएल | बूलियन | कनेक्ट करते समय SSL का उपयोग करना है या नहीं. |
FirestoreSettings.cacheSizeBytes
ध्यान दें: इस फ़ील्ड को भविष्य की प्रमुख रिलीज़ में हटा दिया जाएगा। कैश आकार और अन्य कैश कॉन्फ़िगरेशन निर्दिष्ट करने के लिए इसके बजाय cache फ़ील्ड का उपयोग करें।
ऑन-डिस्क डेटा के लिए अनुमानित कैश आकार सीमा। यदि कैश इस आकार से अधिक बढ़ता है, तो फायरस्टोर उस डेटा को हटाना शुरू कर देगा जिसका हाल ही में उपयोग नहीं किया गया है। आकार इस बात की गारंटी नहीं है कि कैश उस आकार से नीचे रहेगा, केवल यह कि यदि कैश दिए गए आकार से अधिक है, तो सफाई का प्रयास किया जाएगा।
डिफ़ॉल्ट मान 40 एमबी है. सीमा को कम से कम 1 एमबी पर सेट किया जाना चाहिए, और कचरा संग्रहण को अक्षम करने के लिए इसे CACHE_SIZE_UNLIMITED पर सेट किया जा सकता है।
हस्ताक्षर:
cacheSizeBytes?: number;
फायरस्टोरसेटिंग्स.एक्सपेरिमेंटलऑटोडिटेक्टलॉन्गपोलिंग
एसडीके के अंतर्निहित ट्रांसपोर्ट (वेबचैनल) को स्वचालित रूप से यह पता लगाने के लिए कॉन्फ़िगर करता है कि क्या लॉन्ग-पोलिंग का उपयोग किया जाना चाहिए। यह experimentalForceLongPolling के समान है , लेकिन यदि आवश्यक हो तो केवल दीर्घ-मतदान का उपयोग करता है।
2019 में अपनी स्थापना के बाद से false का डिफ़ॉल्ट मान होने के बाद, इस सेटिंग का डिफ़ॉल्ट मान मई 2023 में फायरबेस जावास्क्रिप्ट एसडीके के v9.22.0 में true में बदल दिया गया था। यानी, लंबी पोलिंग का ऑटो-डिटेक्शन अब डिफ़ॉल्ट रूप से सक्षम है। इसे अक्षम करने के लिए, इस सेटिंग को false पर सेट करें , और कृपया उन समस्याओं को साझा करने के लिए एक GitHub मुद्दा खोलें, जिसने आपको लॉन्ग-पोलिंग ऑटो-डिटेक्शन को अक्षम करने के लिए प्रेरित किया।
इस सेटिंग का उपयोग Node.js परिवेश में नहीं किया जा सकता.
हस्ताक्षर:
experimentalAutoDetectLongPolling?: boolean;
FirestoreSettings.experimentalForceLongPolling
एसडीके के अंतर्निहित नेटवर्क ट्रांसपोर्ट (वेबचैनल) को लॉन्ग-पोलिंग का उपयोग करने के लिए बाध्य करता है। बैकएंड से प्रत्येक प्रतिक्रिया बैकएंड द्वारा डेटा भेजने के तुरंत बाद बंद कर दी जाएगी (बैकएंड में भेजने के लिए अधिक डेटा होने की स्थिति में डिफ़ॉल्ट प्रतिक्रियाओं को खुला रखा जाता है)। यह कुछ प्रॉक्सी, एंटीवायरस सॉफ़्टवेयर इत्यादि के साथ असंगतता के मुद्दों से बचाता है जो गलत तरीके से ट्रैफ़िक को अनिश्चित काल तक बफर करते हैं। हालाँकि इस विकल्प के उपयोग से प्रदर्शन में कुछ गिरावट आएगी।
इस सेटिंग का प्रयोग experimentalAutoDetectLongPolling के साथ नहीं किया जा सकता है और भविष्य में रिलीज़ में इसे हटाया जा सकता है। यदि आप स्वयं को किसी विशिष्ट नेटवर्क विश्वसनीयता समस्या के आसपास काम करने के लिए इसका उपयोग करते हुए पाते हैं, तो कृपया हमें https://github.com/firebase/firebase-js-sdk/issues/1674 में इसके बारे में बताएं।
इस सेटिंग का उपयोग Node.js परिवेश में नहीं किया जा सकता.
हस्ताक्षर:
experimentalForceLongPolling?: boolean;
FirestoreSettings.experimentalLongPollingOptions
विकल्प जो लंबे समय तक मतदान का उपयोग करने पर एसडीके के अंतर्निहित नेटवर्क ट्रांसपोर्ट (वेबचैनल) को कॉन्फ़िगर करते हैं।
इन विकल्पों का उपयोग केवल तभी किया जाता है जब experimentalForceLongPolling सत्य है या यदि experimentalAutoDetectLongPolling सत्य है और ऑटो-डिटेक्शन ने निर्धारित किया है कि लंबे मतदान की आवश्यकता थी। अन्यथा, इन विकल्पों का कोई प्रभाव नहीं पड़ता.
हस्ताक्षर:
experimentalLongPollingOptions?: ExperimentalLongPollingOptions;
फायरस्टोरसेटिंग्स.होस्ट
कनेक्ट करने के लिए होस्टनाम.
हस्ताक्षर:
host?: string;
FirestoreSettings.ignoreUnDefinedProperties
क्या नेस्टेड गुणों को छोड़ना है जो ऑब्जेक्ट क्रमबद्धता के दौरान undefined पर सेट हैं। यदि true पर सेट है , इन संपत्तियों को छोड़ दिया जाता है और फायरस्टोर को नहीं लिखा जाता है। यदि false पर सेट किया जाता है या छोड़ दिया जाता है, तो एसडीके undefined प्रकार के गुणों का सामना करने पर एक अपवाद फेंकता है .
हस्ताक्षर:
ignoreUndefinedProperties?: boolean;
FirestoreSettings.localCache
एसडीके द्वारा उपयोग किए गए कैश को निर्दिष्ट करता है। उपलब्ध विकल्प MemoryLocalCache और PersistentLocalCache हैं , प्रत्येक अलग कॉन्फ़िगरेशन विकल्प के साथ।
अनिर्दिष्ट होने पर, MemoryLocalCache उपयोग डिफ़ॉल्ट रूप से किया जाएगा।
नोट: इस फ़ील्ड और cacheSizeBytes एक ही समय में सेट करने से एसडीके आरंभीकरण के दौरान अपवाद उत्पन्न हो जाएगा। इसके बजाय, कैश आकार निर्दिष्ट करने के लिए FirestoreLocalCache ऑब्जेक्ट में कॉन्फ़िगरेशन का उपयोग करें।
हस्ताक्षर:
localCache?: FirestoreLocalCache;
फायरस्टोरसेटिंग्स.एसएसएल
कनेक्ट करते समय SSL का उपयोग करना है या नहीं.
हस्ताक्षर:
ssl?: boolean;