Określa niestandardowe konfiguracje instancji Cloud Firestore. Musisz je ustawić przed wywołaniem innych metod.
Podpis:
export declare interface FirestoreSettings
Właściwości
| Właściwość | Typ | Opis |
|---|---|---|
| cacheSizeBytes. | liczba | UWAGA: to pole zostanie wycofane w przyszłej wersji głównej. Zamiast tego użyj pola cache, aby określić rozmiar pamięci podręcznej i inne konfiguracje pamięci podręcznej.Przybliżony próg rozmiaru pamięci podręcznej dla danych na dysku. Jeśli pamięć podręczna przekroczy ten rozmiar, Firestore zacznie usuwać dane, które nie były ostatnio używane. Rozmiar nie gwarantuje, że pamięć podręczna pozostanie poniżej tego rozmiaru. Podejmujemy próbę czyszczenia, jeśli pamięć podręczna przekroczy podany rozmiar.Wartość domyślna to 40 MB. Próg musi być ustawiony na co najmniej 1 MB i można go ustawić na CACHE_SIZE_UNLIMITED, aby wyłączyć funkcję czyszczenia pamięci. |
| experimentalAutoDetectLongPolling | wartość logiczna | Konfiguruje bazowy transport pakietu SDK (WebChannel) w taki sposób, aby automatycznie wykrywał, czy należy zastosować długie ankiety. Jest to bardzo podobne do experimentalForceLongPolling, ale w razie potrzeby korzysta z długich ankiet tylko w razie potrzeby.Po wprowadzeniu w 2019 r. domyślnej wartości false od momentu jej wprowadzenia w 2019 r. w maju 2023 r. domyślna wartość tego ustawienia została zmieniona na true w wersji 9.22.0 pakietu SDK Firebase JavaScript. Oznacza to, że automatyczne wykrywanie długich ankiet jest teraz domyślnie włączone. Aby je wyłączyć, ustaw to ustawienie na false. Otwórz zgłoszenie GitHub, aby opisać problemy, które spowodowały wyłączenie automatycznego wykrywania długich ankiet.Tego ustawienia nie można używać w środowisku Node.js. |
| eksperymentalne ForceLongPolling | wartość logiczna | Wymusza użycie długich ankiet w ramach transportu sieciowego pakietu SDK (WebChannel). Każda odpowiedź z backendu jest zamykana natychmiast po wysłaniu danych przez backend (domyślnie odpowiedzi pozostają otwarte, jeśli backend ma do wysłania więcej danych). Pozwala to uniknąć problemów z brakiem zgodności z określonymi serwerami proxy, oprogramowaniem antywirusowym itp., które nieprawidłowo buforują ruch w nieskończoność. Zastosowanie tej opcji spowoduje jednak pewne obniżenie wydajności.Tego ustawienia nie można używać z ustawieniem experimentalAutoDetectLongPolling i może ono zostać usunięte w przyszłej wersji. Jeśli stwierdzisz, że używasz jej do rozwiązywania konkretnego problemu z niezawodnością sieci, poinformuj nas o tym na stronie https://github.com/firebase/firebase-js-sdk/issues/1674.Tego ustawienia nie można używać w środowisku Node.js. |
| EksperymentalLongPollingOptions | Funkcja eksperymentalnaLongPollingOptions | Opcje, które konfiguruje podstawowy transport sieciowy (WebChannel) pakietu SDK w przypadku korzystania z długich ankiet.Te opcje są używane tylko wtedy, gdy zasada experimentalForceLongPolling ma wartość prawda lub jeśli experimentalAutoDetectLongPolling ma wartość Prawda, a automatyczne wykrywanie uznało, że konieczne było długie ankiety. W przeciwnym razie te opcje nie mają żadnego efektu. |
| gospodarz | ciąg znaków | Nazwa hosta, z którym ma zostać nawiązane połączenie. |
| ignoreUndefinedWłaściwości. | wartość logiczna | Określa, czy podczas serializacji obiektów mają być pomijane właściwości zagnieżdżone ustawione na undefined. Jeśli ma wartość true, właściwości te są pomijane i nie są zapisywane w Firestore. Jeśli ma wartość false lub jest pominięty, pakiet SDK zgłasza wyjątek w przypadku napotkania właściwości typu undefined. |
| localCache | FirestoreLocalCache | Określa pamięć podręczną używaną przez pakiet SDK. Dostępne opcje to MemoryLocalCache i PersistentLocalCache, a każda z nich ma inne opcje konfiguracji.Jeśli nie określono inaczej, domyślnie będzie używana zasada MemoryLocalCache.UWAGA: jednoczesne ustawienie tego pola oraz pola cacheSizeBytes spowoduje zgłoszenie wyjątku podczas inicjowania pakietu SDK. Zamiast tego użyj konfiguracji w obiekcie FirestoreLocalCache, aby określić rozmiar pamięci podręcznej. |
| ssl, | wartość logiczna | Określa, czy przy nawiązywaniu połączenia ma być używane protokół SSL. |
FirestoreSettings.cacheSizeBytes
UWAGA: to pole zostanie wycofane w przyszłej wersji głównej. Zamiast tego użyj pola cache, aby określić rozmiar pamięci podręcznej i inne konfiguracje pamięci podręcznej.
Przybliżony próg rozmiaru pamięci podręcznej dla danych na dysku. Jeśli pamięć podręczna przekroczy ten rozmiar, Firestore zacznie usuwać dane, które nie były ostatnio używane. Rozmiar nie gwarantuje, że pamięć podręczna pozostanie poniżej tego rozmiaru. Podejmujemy próbę wyczyszczenia pamięci, jeśli pamięć podręczna przekroczy podany rozmiar.
Wartość domyślna to 40 MB. Próg musi być ustawiony na co najmniej 1 MB i można go ustawić na CACHE_SIZE_UNLIMITED, aby wyłączyć funkcję czyszczenia pamięci.
Podpis:
cacheSizeBytes?: number;
FirestoreSettings.experimentalAutoDetectLongPolling
Konfiguruje bazowy transport pakietu SDK (WebChannel) w taki sposób, aby automatycznie wykrywał, czy należy zastosować długie ankiety. Ten wynik jest bardzo podobny do experimentalForceLongPolling, ale w razie potrzeby używane są długie ankiety.
Po wprowadzeniu w 2019 r. tego ustawienia wartość domyślną wynoszącą false została zmieniona w maju 2023 r. na true w wersji 9.22.0 pakietu SDK Firebase JavaScript. Oznacza to, że automatyczne wykrywanie długich ankiet jest teraz domyślnie włączone. Aby je wyłączyć, ustaw to ustawienie na false. Otwórz zgłoszenie na GitHubie, aby opisać problemy, które skłoniły Cię do wyłączenia automatycznego wykrywania długich ankiet.
Tego ustawienia nie można używać w środowisku Node.js.
Podpis:
experimentalAutoDetectLongPolling?: boolean;
FirestoreSettings.experimentalForceLongPolling
Wymusza użycie długich ankiet w ramach transportu sieciowego pakietu SDK (WebChannel). Każda odpowiedź z backendu jest zamykana natychmiast po wysłaniu danych przez backend (domyślnie odpowiedzi pozostają otwarte, jeśli backend ma do wysłania więcej danych). Pozwala to uniknąć problemów z brakiem zgodności z określonymi serwerami proxy, oprogramowaniem antywirusowym itp., które nieprawidłowo buforują ruch w nieskończoność. Spowoduje to jednak pewne obniżenie wydajności.
Tego ustawienia nie można używać z ustawieniem experimentalAutoDetectLongPolling i może ono zostać usunięte w przyszłej wersji. Jeśli stwierdzisz, że używasz jej do rozwiązywania konkretnego problemu z niezawodnością sieci, poinformuj nas o tym na stronie https://github.com/firebase/firebase-js-sdk/issues/1674.
Tego ustawienia nie można używać w środowisku Node.js.
Podpis:
experimentalForceLongPolling?: boolean;
FirestoreSettings.experimentalLongPollingOptions
Opcje, które konfiguruje bazowy transport sieciowy pakietu SDK (WebChannel) podczas korzystania z długiego sondowania.
Te opcje są używane tylko wtedy, gdy experimentalForceLongPolling ma wartość prawda lub experimentalAutoDetectLongPolling ma wartość prawda, a automatyczne wykrywanie uznało, że było potrzebne długie badanie. W przeciwnym razie te opcje nie mają żadnego efektu.
Podpis:
experimentalLongPollingOptions?: ExperimentalLongPollingOptions;
Host FirestoreSettings.host
Nazwa hosta, z którym ma zostać nawiązane połączenie.
Podpis:
host?: string;
FirestoreSettings.ignoreUndefinedWłaściwości
Określa, czy podczas serializacji obiektów mają być pomijane właściwości zagnieżdżone ustawione na undefined. Jeśli ma wartość true, właściwości te są pomijane i nie są zapisywane w Firestore. Jeśli ma wartość false lub jest pominięty, pakiet SDK zgłasza wyjątek w przypadku napotkania właściwości typu undefined.
Podpis:
ignoreUndefinedProperties?: boolean;
FirestoreSettings.localCache
Określa pamięć podręczną używaną przez pakiet SDK. Dostępne opcje to MemoryLocalCache i PersistentLocalCache. Każda z nich ma inne opcje konfiguracji.
Jeśli nie określono inaczej, domyślnie będzie używana funkcja MemoryLocalCache.
UWAGA: jednoczesne ustawienie tego pola i pola cacheSizeBytes spowoduje zgłoszenie wyjątku podczas inicjowania pakietu SDK. Zamiast tego użyj konfiguracji w obiekcie FirestoreLocalCache, aby określić rozmiar pamięci podręcznej.
Podpis:
localCache?: FirestoreLocalCache;
FirestoreSettings.ssl
Określa, czy przy nawiązywaniu połączenia ma być używane protokół SSL.
Podpis:
ssl?: boolean;