FirestoreSettings interface

Указывает пользовательские конфигурации для вашего экземпляра Cloud Firestore. Вы должны установить их перед вызовом любых других методов.

Подпись:

export declare interface FirestoreSettings 

Характеристики

FirestoreSettings.cacheSizeBytes

ПРИМЕЧАНИЕ. Это поле будет устарело в будущей основной версии. Вместо этого используйте поле cache , чтобы указать размер кэша и другие конфигурации кэша.

Приблизительный порог размера кэша для данных на диске. Если размер кеша превысит этот размер, Firestore начнет удалять данные, которые в последнее время не использовались. Размер не является гарантией того, что размер кеша останется ниже этого размера; только если размер кеша превысит заданный, будет предпринята попытка очистки.

Значение по умолчанию — 40 МБ. Порог должен быть установлен как минимум на 1 МБ и может быть установлен на CACHE_SIZE_UNLIMITED , чтобы отключить сбор мусора.

Подпись:

cacheSizeBytes?: number;

FirestoreSettings.experimentalAutoDetectLongPolling

Настраивает базовый транспорт SDK (WebChannel) для автоматического определения необходимости использования длительного опроса. Это очень похоже на experimentalForceLongPolling . , но использует длинный опрос только при необходимости.

После того, как с момента его создания в 2019 году у него было значение по умолчанию false , в мае 2023 года значение по умолчанию для этого параметра было изменено на true в версии 9.22.0 Firebase JavaScript SDK. То есть автоопределение длинного опроса теперь включено по умолчанию. Чтобы отключить его, установите для этого параметра значение false и, пожалуйста, откройте выпуск GitHub, чтобы рассказать о проблемах, которые побудили вас отключить автоматическое обнаружение при длительном опросе.

Этот параметр нельзя использовать в среде Node.js.

Подпись:

experimentalAutoDetectLongPolling?: boolean;

FirestoreSettings.experimentalForceLongPolling

Заставляет базовый сетевой транспорт SDK (WebChannel) использовать длинный опрос. Каждый ответ от серверной части будет закрыт сразу после того, как серверная часть отправит данные (по умолчанию ответы остаются открытыми, если у серверной части есть дополнительные данные для отправки). Это позволяет избежать проблем несовместимости с некоторыми прокси-серверами, антивирусным программным обеспечением и т. д., которые неправильно буферизуют трафик на неопределенный срок. Однако использование этой опции приведет к некоторому снижению производительности.

Этот параметр нельзя использовать с experimentalAutoDetectLongPolling и он может быть удален в будущем выпуске. Если вы обнаружите, что используете его для решения конкретной проблемы с надежностью сети, сообщите нам об этом в https://github.com/firebase/firebase-js-sdk/issues/1674.

Этот параметр нельзя использовать в среде Node.js.

Подпись:

experimentalForceLongPolling?: boolean;

FirestoreSettings.experimentalLongPollingOptions

Параметры, настраивающие базовый сетевой транспорт SDK (WebChannel) при использовании длительного опроса.

Эти параметры используются только в том случае, если experimentalForceLongPolling имеет значение true или experimentalAutoDetectLongPolling имеет значение true и автоматическое обнаружение определило, что необходим длительный опрос. В противном случае эти параметры не имеют никакого эффекта.

Подпись:

experimentalLongPollingOptions?: ExperimentalLongPollingOptions;

FirestoreSettings.host

Имя хоста для подключения.

Подпись:

host?: string;

FirestoreSettings.ignoreUndefineProperties

Пропускать ли вложенные свойства, которым присвоено undefined во время сериализации объекта. Если установлено значение true , эти свойства пропускаются и не записываются в Firestore. Если установлено значение false или опущено, SDK выдает исключение при обнаружении свойств undefined типа. .

Подпись:

ignoreUndefinedProperties?: boolean;

FirestoreSettings.localCache

Указывает кеш, используемый SDK. Доступные варианты: MemoryLocalCache и PersistentLocalCache , каждый из которых имеет разные параметры конфигурации.

Если не указано, MemoryLocalCache будет использоваться по умолчанию.

ПРИМЕЧАНИЕ. Одновременная установка этого поля и cacheSizeBytes приведет к возникновению исключения во время инициализации SDK. Вместо этого используйте конфигурацию объекта FirestoreLocalCache для указания размера кэша.

Подпись:

localCache?: FirestoreLocalCache;

FirestoreSettings.ssl

Использовать ли SSL при подключении.

Подпись:

ssl?: boolean;