FirestoreSettings interface

Especifica configuraciones personalizadas para su instancia de Cloud Firestore. Debe configurarlos antes de invocar cualquier otro método.

Firma:

export declare interface FirestoreSettings 

Propiedades

FirestoreSettings.cacheSizeBytes

NOTA: Este campo quedará obsoleto en una versión importante futura. Utilice el campo cache en su lugar para especificar el tamaño de la caché y otras configuraciones de la caché.

Un umbral de tamaño de caché aproximado para los datos en el disco. Si el caché crece más allá de este tamaño, Firestore comenzará a eliminar los datos que no se hayan utilizado recientemente. El tamaño no es una garantía de que el caché permanecerá por debajo de ese tamaño, solo que si el caché excede el tamaño dado, se intentará la limpieza.

El valor predeterminado es 40 MB. El umbral se debe establecer en al menos 1 MB y se puede establecer en CACHE_SIZE_UNLIMITED para deshabilitar la recolección de basura.

Firma:

cacheSizeBytes?: number;

FirestoreSettings.experimentalAutoDetectLongPolling

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

Después de haber tenido un valor predeterminado de false desde su inicio en 2019, el valor predeterminado de esta configuración se cambió en mayo de 2023 a true en la versión 9.22.0 del SDK de JavaScript de Firebase. Es decir, la detección automática de sondeos largos ahora está habilitada de forma predeterminada. Para desactivarlo, establezca esta configuración en false y abra una incidencia de GitHub para compartir los problemas que le motivaron a desactivar la detección automática de sondeo prolongado.

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

Firma:

experimentalAutoDetectLongPolling?: boolean;

FirestoreSettings.experimentalForceLongPolling

Obliga al transporte de red subyacente del SDK (WebChannel) a utilizar un sondeo prolongado. 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 servidores proxy, software antivirus, etc. que almacenan incorrectamente el tráfico de forma indefinida. Sin embargo, el uso de esta opción provocará cierta degradación del rendimiento.

Esta configuración no se puede utilizar con experimentalAutoDetectLongPolling y es posible que se elimine en una versión futura. Si lo utiliza para solucionar un problema específico de confiabilidad de la red, infórmenos en https://github.com/firebase/firebase-js-sdk/issues/1674.

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

Firma:

experimentalForceLongPolling?: boolean;

FirestoreSettings.experimentalLongPollingOptions

Opciones que configuran el transporte de red subyacente del SDK (WebChannel) cuando se utiliza 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 un sondeo largo. De lo contrario, estas opciones no tendrán efecto.

Firma:

experimentalLongPollingOptions?: ExperimentalLongPollingOptions;

FirestoreSettings.host

El nombre de host al que conectarse.

Firma:

host?: string;

FirestoreSettings.ignoreUndefinitedProperties

Si se deben omitir las propiedades anidadas que están configuradas como undefined durante la serialización de objetos. Si se establece en true , estas propiedades se omiten y no se escriben en Firestore. Si se establece en false o se omite, el SDK genera una excepción cuando encuentra propiedades de tipo undefined .

Firma:

ignoreUndefinedProperties?: boolean;

FirestoreSettings.localCache

Especifica la caché utilizada por el SDK. Las opciones disponibles son MemoryLocalCache y PersistentLocalCache , cada uno con diferentes opciones de configuración.

Cuando no se especifica, MemoryLocalCache se utilizará de forma predeterminada.

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

Firma:

localCache?: FirestoreLocalCache;

FirestoreSettings.ssl

Si se debe utilizar SSL al conectarse.

Firma:

ssl?: boolean;