Określa niestandardowe konfiguracje instancji Cloud Firestore. Należy je ustawić przed wywołaniem jakichkolwiek innych metod.
Podpis:
export declare interface FirestoreSettings
Nieruchomości
| Nieruchomość | Typ | Opis |
|---|---|---|
| rozmiar pamięci podręcznej | numer | UWAGA: To pole będzie przestarzałe w przyszłej głównej wersji. 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 rozpocznie usuwanie danych, które nie były ostatnio używane. Rozmiar nie gwarantuje, że pamięć podręczna pozostanie poniżej tego rozmiaru, a jedynie to, że jeśli pamięć podręczna przekroczy podany rozmiar, zostanie podjęta próba oczyszczenia. 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ć zbieranie elementów bezużytecznych. |
| eksperymentalneAutoDetectLongPolling | wartość logiczna | Konfiguruje podstawowy transport zestawu SDK (WebChannel), aby automatycznie wykrywał, czy należy użyć długiego sondowania. Jest to bardzo podobne do experimentalForceLongPolling , ale w razie potrzeby używa tylko długiego odpytywania. Po tym, jak od momentu powstania w 2019 r. domyślna wartość tego ustawienia wynosiła false , w maju 2023 r. domyślna wartość tego ustawienia została zmieniona na true w wersji 9.22.0 pakietu SDK Firebase JavaScript SDK. Oznacza to, że automatyczne wykrywanie długiego odpytywania jest teraz domyślnie włączone. Aby to wyłączyć, ustaw to ustawienie na false i otwórz zgłoszenie w GitHubie, aby podzielić się problemami, które zmotywowały Cię do wyłączenia automatycznego wykrywania długiego odpytywania. Tego ustawienia nie można używać w środowisku Node.js. |
| eksperymentalneForceLongPolling | wartość logiczna | Wymusza, aby podstawowy transport sieciowy pakietu SDK (WebChannel) korzystał z długiego odpytywania. Każda odpowiedź z backendu zostanie zamknięta natychmiast po wysłaniu danych przez backend (domyślnie odpowiedzi pozostają otwarte na wypadek, gdyby backend miał więcej danych do wysłania). Pozwala to uniknąć problemów ze zgodnością z niektórymi serwerami proxy, oprogramowaniem antywirusowym itp., które nieprawidłowo buforują ruch w nieskończoność. Użycie tej opcji spowoduje jednak pewne pogorszenie wydajności. Tego ustawienia nie można używać z experimentalAutoDetectLongPolling i może zostać usunięte w przyszłej wersji. Jeśli zauważysz, że używasz go do obejścia konkretnego problemu z niezawodnością sieci, poinformuj nas o tym na https://github.com/firebase/firebase-js-sdk/issues/1674. Tego ustawienia nie można używać w środowisku Node.js. |
| eksperymentalneLongPollingOptions | Eksperymentalne opcje LongPolling | Opcje konfigurujące podstawowy transport sieciowy zestawu SDK (WebChannel), gdy używane jest długie odpytywanie. Opcje te są używane tylko wtedy, gdy experimentalForceLongPolling ma wartość true lub jeśli experimentalAutoDetectLongPolling ma wartość true, a automatyczne wykrywanie ustaliło, że konieczne było długie odpytywanie. W przeciwnym razie opcje te nie będą miały żadnego efektu. |
| gospodarz | strunowy | Nazwa hosta, z którym można się połączyć. |
| zignorowaćNiezdefiniowaneWłaściwości | wartość logiczna | Określa, czy pominąć właściwości zagnieżdżone, które podczas serializacji obiektu są ustawione na undefined . Jeśli ustawione na true , te właściwości są pomijane i nie są zapisywane w Firestore. W przypadku ustawienia wartości false lub pominięcia zestaw SDK zgłasza wyjątek, gdy napotka właściwości typu undefined . |
| lokalna pamięć podręczna | Lokalna pamięć podręczna Firestore | Określa pamięć podręczną używaną przez zestaw SDK. Dostępne opcje to MemoryLocalCache i PersistentLocalCache , każda z różnymi opcjami konfiguracji. Jeśli nie określono, domyślnie będzie używana MemoryLocalCache . UWAGA: jednoczesne ustawienie tego pola i cacheSizeBytes spowoduje zgłoszenie wyjątku podczas inicjalizacji SDK. Zamiast tego użyj konfiguracji w obiekcie FirestoreLocalCache , aby określić rozmiar pamięci podręcznej. |
| ssl | wartość logiczna | Czy podczas łączenia używać protokołu SSL. |
FirestoreSettings.cacheSizeBytes
UWAGA: To pole będzie przestarzałe w przyszłej głównej wersji. 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 rozpocznie usuwanie danych, które nie były ostatnio używane. Rozmiar nie gwarantuje, że pamięć podręczna pozostanie poniżej tego rozmiaru, a jedynie to, że jeśli pamięć podręczna przekroczy podany rozmiar, zostanie podjęta próba oczyszczenia.
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ć zbieranie elementów bezużytecznych.
Podpis:
cacheSizeBytes?: number;
FirestoreSettings.experimentalAutoDetectLongPolling
Konfiguruje podstawowy transport zestawu SDK (WebChannel), aby automatycznie wykrywał, czy należy użyć długiego sondowania. Jest to bardzo podobne do experimentalForceLongPolling , ale używa tylko długiego odpytywania, jeśli jest to wymagane.
Po tym, jak od momentu powstania w 2019 r. domyślna wartość tego ustawienia wynosiła false , w maju 2023 r. domyślna wartość tego ustawienia została zmieniona na true w wersji 9.22.0 pakietu SDK Firebase JavaScript SDK. Oznacza to, że automatyczne wykrywanie długiego odpytywania jest teraz domyślnie włączone. Aby to wyłączyć, ustaw to ustawienie na false i otwórz zgłoszenie w GitHubie, aby podzielić się problemami, które zmotywowały Cię do wyłączenia automatycznego wykrywania długich odpytywania.
Tego ustawienia nie można używać w środowisku Node.js.
Podpis:
experimentalAutoDetectLongPolling?: boolean;
FirestoreSettings.experimentalForceLongPolling
Wymusza, aby podstawowy transport sieciowy pakietu SDK (WebChannel) korzystał z długiego odpytywania. Każda odpowiedź z backendu zostanie zamknięta natychmiast po wysłaniu danych przez backend (domyślnie odpowiedzi pozostają otwarte na wypadek, gdyby backend miał więcej danych do wysłania). Pozwala to uniknąć problemów ze zgodnością z niektórymi serwerami proxy, oprogramowaniem antywirusowym itp., które nieprawidłowo buforują ruch w nieskończoność. Użycie tej opcji spowoduje jednak pewne pogorszenie wydajności.
Tego ustawienia nie można używać z experimentalAutoDetectLongPolling i może zostać usunięte w przyszłej wersji. Jeśli zauważysz, że używasz go do obejścia konkretnego problemu z niezawodnością sieci, poinformuj nas o tym na 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 konfigurujące podstawowy transport sieciowy zestawu SDK (WebChannel), gdy używane jest długie odpytywanie.
Opcje te są używane tylko wtedy, gdy experimentalForceLongPolling ma wartość true lub jeśli experimentalAutoDetectLongPolling ma wartość true, a automatyczne wykrywanie ustaliło, że konieczne było długie odpytywanie. W przeciwnym razie opcje te nie będą miały żadnego efektu.
Podpis:
experimentalLongPollingOptions?: ExperimentalLongPollingOptions;
FirestoreSettings.host
Nazwa hosta, z którym można się połączyć.
Podpis:
host?: string;
FirestoreSettings.ignoreUnknownProperties
Określa, czy pominąć właściwości zagnieżdżone, które podczas serializacji obiektu są ustawione na undefined . Jeśli ustawione na true , te właściwości są pomijane i nie są zapisywane w Firestore. W przypadku ustawienia wartości false lub pominięcia zestaw SDK zgłasza wyjątek, gdy napotka właściwości typu undefined .
Podpis:
ignoreUndefinedProperties?: boolean;
FirestoreSettings.localCache
Określa pamięć podręczną używaną przez zestaw SDK. Dostępne opcje to MemoryLocalCache i PersistentLocalCache , każdy z różnymi opcjami konfiguracji.
Jeśli nie określono, domyślnie będzie używana MemoryLocalCache .
UWAGA: jednoczesne ustawienie tego pola i cacheSizeBytes spowoduje zgłoszenie wyjątku podczas inicjalizacji SDK. Zamiast tego użyj konfiguracji w obiekcie FirestoreLocalCache , aby określić rozmiar pamięci podręcznej.
Podpis:
localCache?: FirestoreLocalCache;
FirestoreSettings.ssl
Czy podczas łączenia używać protokołu SSL.
Podpis:
ssl?: boolean;