Cloud Firestore örneğiniz için özel yapılandırmaları belirtir. Başka yöntemleri çağırmadan önce bunları ayarlamanız gerekir.
İmza:
export declare interface FirestoreSettings
Özellikler
| Mülk | Tip | Tanım |
|---|---|---|
| önbellekBoyutuBytes | sayı | NOT: Bu alan gelecekteki bir büyük sürümde kullanımdan kaldırılacaktır. Önbellek boyutunu ve diğer önbellek yapılandırmalarını belirtmek için bunun yerine cache alanını kullanın. Diskteki veriler için yaklaşık önbellek boyutu eşiği. Önbellek bu boyutu aşarsa Firestore yakın zamanda kullanılmayan verileri kaldırmaya başlayacaktır. Boyut, önbelleğin bu boyutun altında kalacağını garanti etmez; yalnızca önbellek belirtilen boyutu aşarsa temizleme girişiminde bulunulur. Varsayılan değer 40 MB'tır. Eşik en az 1 MB'ye ayarlanmalıdır ve çöp toplamayı devre dışı bırakmak için CACHE_SIZE_UNLIMITED olarak ayarlanabilir. |
| deneyselOtomatik AlgılamaUzunYoklama | boolean | Uzun yoklamanın kullanılması gerekip gerekmediğini otomatik olarak algılamak için SDK'nın temel aktarımını (WebChannel) yapılandırır. Bu, experimentalForceLongPolling çok benzer, ancak yalnızca gerekirse uzun yoklama kullanır. 2019'daki başlangıcından bu yana varsayılan değeri false olan bu ayarın varsayılan değeri, Firebase JavaScript SDK'nın v9.22.0 sürümünde Mayıs 2023'te true olarak değiştirildi. Yani, uzun yoklamanın otomatik olarak algılanması artık varsayılan olarak etkindir. Bunu devre dışı bırakmak için bu ayarı false olarak ayarlayın ve lütfen uzun yoklamalı otomatik algılamayı devre dışı bırakmanıza neden olan sorunları paylaşmak için bir GitHub sorunu açın. Bu ayar Node.js ortamında kullanılamaz. |
| deneyselForceLongPolling | boolean | SDK'nın temel ağ aktarımını (WebChannel) uzun yoklamayı kullanmaya zorlar. Arka uçtan gelen her yanıt, arka uç verileri gönderdikten hemen sonra kapatılacaktır (arka uçta gönderilecek daha fazla veri olması durumunda yanıtlar varsayılan olarak açık tutulur). Bu, trafiği süresiz olarak hatalı şekilde ara belleğe alan belirli proxy'ler, antivirüs yazılımları vb. ile uyumsuzluk sorunlarını önler. Bu seçeneğin kullanılması performansın bir miktar düşmesine neden olacaktır. Bu ayar experimentalAutoDetectLongPolling ile kullanılamaz ve gelecekteki bir sürümde kaldırılabilir. Belirli bir ağ güvenilirliği sorununu çözmek için bunu kullandığınızı fark ederseniz, lütfen https://github.com/firebase/firebase-js-sdk/issues/1674 adresinden bize bildirin. Bu ayar Node.js ortamında kullanılamaz. |
| deneyselUzunYoklamaSeçenekleri | DeneyselUzun Yoklama Seçenekleri | Uzun yoklama kullanıldığında SDK'nın temel ağ aktarımını (WebChannel) yapılandıran seçenekler. Bu seçenekler yalnızca experimentalForceLongPolling doğruysa veya experimentalAutoDetectLongPolling doğruysa ve otomatik algılama uzun yoklamanın gerekli olduğunu belirlediyse kullanılır. Aksi takdirde bu seçeneklerin hiçbir etkisi yoktur. |
| ev sahibi | sicim | Bağlanılacak ana bilgisayar adı. |
| yoksayUntanımlanmamışÖzellikler | boolean | Nesne serileştirme sırasında undefined olarak ayarlanan iç içe geçmiş özelliklerin atlanıp atlanmayacağı. true olarak ayarlanırsa bu özellikler atlanır ve Firestore'a yazılmaz. false olarak ayarlanırsa veya atlanırsa SDK, undefined türündeki özelliklerle karşılaştığında bir istisna oluşturur. |
| yerelÖnbellek | FirestoreLocalCache | SDK tarafından kullanılan önbelleği belirtir. Kullanılabilir seçenekler MemoryLocalCache ve PersistentLocalCache olup her biri farklı yapılandırma seçeneklerine sahiptir. Belirtilmediğinde varsayılan olarak MemoryLocalCache kullanılacaktır. NOT: Bu alanın ve cacheSizeBytes aynı anda ayarlanması, SDK'nın başlatılması sırasında istisna oluşturacaktır. Bunun yerine, önbellek boyutunu belirtmek için FirestoreLocalCache nesnesindeki yapılandırmayı kullanın. |
| ssl | boolean | Bağlanırken SSL kullanılıp kullanılmayacağı. |
FirestoreSettings.cacheSizeBytes
NOT: Bu alan gelecekteki bir büyük sürümde kullanımdan kaldırılacaktır. Önbellek boyutunu ve diğer önbellek yapılandırmalarını belirtmek için bunun yerine cache alanını kullanın.
Diskteki veriler için yaklaşık önbellek boyutu eşiği. Önbellek bu boyutu aşarsa Firestore yakın zamanda kullanılmayan verileri kaldırmaya başlayacaktır. Boyut, önbelleğin bu boyutun altında kalacağını garanti etmez; yalnızca önbellek belirtilen boyutu aşarsa temizleme girişiminde bulunulur.
Varsayılan değer 40 MB'dir. Eşik en az 1 MB'ye ayarlanmalıdır ve çöp toplamayı devre dışı bırakmak için CACHE_SIZE_UNLIMITED olarak ayarlanabilir.
İmza:
cacheSizeBytes?: number;
FirestoreSettings.experimentalAutoDetectLongPolling
Uzun yoklamanın kullanılması gerekip gerekmediğini otomatik olarak algılamak için SDK'nın temel aktarımını (WebChannel) yapılandırır. Bu experimentalForceLongPolling çok benzer , ancak yalnızca gerekirse uzun yoklama kullanır.
2019'daki başlangıcından bu yana varsayılan değeri false olan bu ayarın varsayılan değeri, Firebase JavaScript SDK'nın v9.22.0 sürümünde Mayıs 2023'te true olarak değiştirildi. Yani, uzun yoklamanın otomatik olarak algılanması artık varsayılan olarak etkindir. Devre dışı bırakmak için bu ayarı false olarak ayarlayın ve uzun yoklama otomatik algılamasını devre dışı bırakmanıza neden olan sorunları paylaşmak için lütfen bir GitHub sorunu açın.
Bu ayar Node.js ortamında kullanılamaz.
İmza:
experimentalAutoDetectLongPolling?: boolean;
FirestoreSettings.experimentalForceLongPolling
SDK'nın temel ağ aktarımını (WebChannel) uzun yoklamayı kullanmaya zorlar. Arka uçtan gelen her yanıt, arka uç verileri gönderdikten hemen sonra kapatılacaktır (arka uçta gönderilecek daha fazla veri olması durumunda yanıtlar varsayılan olarak açık tutulur). Bu, trafiği süresiz olarak hatalı şekilde ara belleğe alan belirli proxy'ler, antivirüs yazılımları vb. ile uyumsuzluk sorunlarını önler. Bu seçeneğin kullanılması performansın bir miktar düşmesine neden olacaktır.
Bu ayar experimentalAutoDetectLongPolling ile kullanılamaz ve gelecekteki bir sürümde kaldırılabilir. Belirli bir ağ güvenilirliği sorununu çözmek için bunu kullandığınızı fark ederseniz, lütfen https://github.com/firebase/firebase-js-sdk/issues/1674 adresinden bize bildirin.
Bu ayar Node.js ortamında kullanılamaz.
İmza:
experimentalForceLongPolling?: boolean;
FirestoreSettings.experimentalLongPollingOptions
Uzun yoklama kullanıldığında SDK'nın temel ağ aktarımını (WebChannel) yapılandıran seçenekler.
Bu seçenekler yalnızca experimentalForceLongPolling doğruysa veya experimentalAutoDetectLongPolling doğruysa ve otomatik algılama uzun yoklamanın gerekli olduğunu belirlediyse kullanılır. Aksi takdirde bu seçeneklerin hiçbir etkisi yoktur.
İmza:
experimentalLongPollingOptions?: ExperimentalLongPollingOptions;
FirestoreSettings.host
Bağlanılacak ana bilgisayar adı.
İmza:
host?: string;
FirestoreSettings.ignoreUnDefinitionProperties
Nesne serileştirme sırasında undefined olarak ayarlanan iç içe geçmiş özelliklerin atlanıp atlanmayacağı. true olarak ayarlanırsa , bu özellikler atlanır ve Firestore'a yazılmaz. false olarak ayarlanırsa veya atlanırsa SDK, undefined türdeki özelliklerle karşılaştığında bir özel durum oluşturur .
İmza:
ignoreUndefinedProperties?: boolean;
FirestoreSettings.localCache
SDK tarafından kullanılan önbelleği belirtir. Mevcut seçenekler MemoryLocalCache ve PersistentLocalCache , her biri farklı yapılandırma seçeneklerine sahiptir.
Belirtilmediğinde varsayılan olarak MemoryLocalCache kullanılacaktır.
NOT: Bu alanın ve cacheSizeBytes aynı anda ayarlanması, SDK'nın başlatılması sırasında istisna oluşturacaktır. Bunun yerine, önbellek boyutunu belirtmek için FirestoreLocalCache nesnesindeki yapılandırmayı kullanın.
İmza:
localCache?: FirestoreLocalCache;
FirestoreSettings.ssl
Bağlanırken SSL kullanılıp kullanılmayacağı.
İmza:
ssl?: boolean;