FirestoreSettings interface

Especifica la configuración personalizada para tu instancia de Cloud Firestore. Debes configurarlos antes de invocar cualquier otro método.

Firma:

export declare interface FirestoreSettings 

Propiedades

FirestoreSettings.cacheSizeBytes

NOTA: Este campo dejará de estar disponible en una versión importante futura. En su lugar, usa el campo cache para especificar el tamaño y otros parámetros de configuración de la caché.

Un umbral aproximado de tamaño de caché para los datos en el disco. Si la caché supera este tamaño, Firestore comenzará a quitar los datos que no se hayan usado recientemente. El tamaño no es una garantía de que la caché se mantendrá por debajo de ese tamaño, solo que se intentará realizar la limpieza si la caché supera el tamaño determinado.

El valor predeterminado es 40 MB. El umbral se debe establecer en 1 MB como mínimo y se puede establecer en CACHE_SIZE_UNLIMITED para inhabilitar la recolección de elementos no utilizados.

Firma:

cacheSizeBytes?: number;

FirestoreSettings.experimentalAutoDetectLongPolling

Configura el transporte subyacente del SDK (WebChannel) para detectar automáticamente si se debe usar sondeo largo. Es muy similar a experimentalForceLongPolling, pero solo usa sondeos largos si es necesario.

Después de tener un valor predeterminado de false desde su inicio en 2019, el valor predeterminado de este parámetro de configuración se cambió en mayo de 2023 a true en la versión 9.22.0 del SDK de Firebase JavaScript. Es decir, la detección automática de sondeos largos ahora está habilitada de forma predeterminada. Para inhabilitarla, establece este parámetro de configuración en false y abre un problema de GitHub para compartir los problemas que te motivaron a inhabilitar la detección automática de sondeo largo.

Esta configuración no se puede usar en un entorno de Node.js.

Firma:

experimentalAutoDetectLongPolling?: boolean;

FirestoreSettings.experimentalForceLongPolling

Fuerza el transporte de red subyacente del SDK (WebChannel) a usar el sondeo largo. Cada respuesta del backend se cerrará inmediatamente después de que el backend envíe datos (de forma predeterminada, las respuestas se mantienen abiertas en caso de que el backend tenga más datos para enviar). Esto evita problemas de incompatibilidad con ciertos proxies, software antivirus, etc., que almacenan incorrectamente el tráfico de forma indefinida. Sin embargo, usar esta opción puede degradar el rendimiento.

Este parámetro de configuración no se puede usar con experimentalAutoDetectLongPolling y es posible que se quite en una versión futura. Si descubres que la usas para solucionar un problema específico de confiabilidad de la red, indícanos en https://github.com/firebase/firebase-js-sdk/issues/1674.

Esta configuración no se puede usar en un entorno de Node.js.

Firma:

experimentalForceLongPolling?: boolean;

FirestoreSettings.experimentalLongPollingOptions

Opciones que configuran el transporte de red subyacente del SDK (WebChannel) cuando se usa el sondeo largo.

Estas opciones solo se usan si experimentalForceLongPolling es verdadero o si experimentalAutoDetectLongPolling es verdadero y la detección automática determinó que se necesitaba el sondeo largo. De lo contrario, estas opciones no tienen efecto.

Firma:

experimentalLongPollingOptions?: ExperimentalLongPollingOptions;

FirestoreSettings.host

El nombre de host al que se conectará.

Firma:

host?: string;

FirestoreSettings.ignoreUndefinedProperties

Establece si se deben omitir las propiedades anidadas que se configuran en undefined durante la serialización de objetos. Si se configura como true, estas propiedades se omiten y no se escriben en Firestore. Si se configura como false o se omite, el SDK arrojará una excepción cuando encuentre propiedades del tipo undefined.

Firma:

ignoreUndefinedProperties?: boolean;

FirestoreSettings.localCache

Especifica la caché que usa el SDK. Las opciones disponibles son MemoryLocalCache y PersistentLocalCache, cada una con diferentes opciones de configuración.

Si no se especifica, se usará MemoryLocalCache de forma predeterminada.

NOTA: Si configuras este campo y cacheSizeBytes al mismo tiempo, se generará una excepción durante la inicialización del SDK. En su lugar, usa la configuración del objeto FirestoreLocalCache para especificar el tamaño de la caché.

Firma:

localCache?: FirestoreLocalCache;

FirestoreSettings.ssl

Indica si se debe usar SSL durante la conexión.

Firma:

ssl?: boolean;