Especifica configuraciones personalizadas para su instancia de Cloud Firestore. Debe configurarlos antes de invocar cualquier otro método.
Firma:
export declare interface FirestoreSettings
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| cachéTamañoBytes | número | NOTA: Este campo quedará obsoleto en una versión principal futura. Utilice el campo cache en su lugar para especificar el tamaño de caché y otras configuraciones de caché. Un umbral de tamaño de caché aproximado para los datos en 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 elementos no utilizados. |
| experimentalAutoDetectLargoEncuesta | booleano | Configura el transporte subyacente del SDK (WebChannel) para detectar automáticamente si se debe usar un sondeo largo. Esto es muy similar a experimentalForceLongPolling , pero solo usa un sondeo largo si es necesario. Después de haber tenido un valor predeterminado de false desde su creación 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 deshabilitarlo, establezca esta configuración en false y abra un problema de GitHub para compartir los problemas que lo motivaron a deshabilitar la detección automática de sondeo prolongado. Esta configuración no se puede usar en un entorno Node.js. |
| experimentalFuerzaLargaEncuesta | booleano | Obliga al transporte de red subyacente del SDK (WebChannel) a usar un sondeo largo. Cada respuesta del backend se cerrará inmediatamente después de que el backend envíe datos (de manera 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 indefinidamente. Sin embargo, el uso de esta opción provocará cierta degradación del rendimiento. Esta configuración no se puede usar con experimentalAutoDetectLongPolling y se puede eliminar en una versión futura. Si se encuentra usándolo para solucionar un problema específico de confiabilidad de la red, infórmenos al respecto en https://github.com/firebase/firebase-js-sdk/issues/1674. Esta configuración no se puede usar en un entorno Node.js. |
| experimentalLongPollingOptions | ExperimentalLongPollingOptionsExperimentalLongPollingOptions | 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 un sondeo prolongado. De lo contrario, estas opciones no tienen efecto. |
| anfitrión | cadena | El nombre de host al que conectarse. |
| ignorarUndefinedProperties | booleano | Si se deben omitir las propiedades anidadas que se establecen 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 . |
| caché local | FirestoreLocalCache | Especifica la memoria caché utilizada por el SDK. Las opciones disponibles son MemoryLocalCache y PersistentLocalCache , cada una 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, usa la configuración en el objeto FirestoreLocalCache para especificar el tamaño de la memoria caché. |
| SSL | booleano | Ya sea para usar SSL al conectarse. |
FirestoreSettings.cacheSizeBytes
NOTA: Este campo quedará obsoleto en una versión principal futura. Utilice el campo cache en su lugar para especificar el tamaño de caché y otras configuraciones de caché.
Un umbral de tamaño de caché aproximado para los datos en disco. Si el caché crece más allá de este tamaño, Firestore comenzará a eliminar los datos que no se hayan usado 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 elementos no utilizados.
Firma:
cacheSizeBytes?: number;
FirestoreSettings.experimentalAutoDetectEncuesta larga
Configura el transporte subyacente del SDK (WebChannel) para detectar automáticamente si se debe usar un sondeo largo. Esto es muy similar a experimentalForceLongPolling , pero solo usa el sondeo largo si es necesario.
Después de haber tenido un valor predeterminado de false desde su creación 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 deshabilitarlo, establezca esta configuración en false y abra un problema de GitHub para compartir los problemas que lo motivaron a deshabilitar la detección automática de sondeo prolongado.
Esta configuración no se puede usar en un entorno Node.js.
Firma:
experimentalAutoDetectLongPolling?: boolean;
FirestoreSettings.experimentalForceLongPolling
Obliga al transporte de red subyacente del SDK (WebChannel) a usar un sondeo largo. Cada respuesta del backend se cerrará inmediatamente después de que el backend envíe datos (de manera 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 indefinidamente. Sin embargo, el uso de esta opción provocará cierta degradación del rendimiento.
Esta configuración no se puede usar con experimentalAutoDetectLongPolling y se puede eliminar en una versión futura. Si se encuentra usándolo para solucionar un problema específico de confiabilidad de la red, infórmenos al respecto en https://github.com/firebase/firebase-js-sdk/issues/1674.
Esta configuración no se puede usar en un entorno 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 un sondeo prolongado. De lo contrario, estas opciones no tienen efecto.
Firma:
experimentalLongPollingOptions?: ExperimentalLongPollingOptions;
Configuración de Firestore.host
El nombre de host al que conectarse.
Firma:
host?: string;
FirestoreSettings.ignoreUndefinedProperties
Si se deben omitir las propiedades anidadas que se establecen 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 memoria 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, usa la configuración en el objeto FirestoreLocalCache para especificar el tamaño de la memoria caché.
Firma:
localCache?: FirestoreLocalCache;
Configuración de Firestore.ssl
Ya sea para usar SSL al conectarse.
Firma:
ssl?: boolean;
Especifica configuraciones personalizadas para su instancia de Cloud Firestore. Debe configurarlos antes de invocar cualquier otro método.
Firma:
export declare interface FirestoreSettings
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| cachéTamañoBytes | número | NOTA: Este campo quedará obsoleto en una versión principal futura. Utilice el campo cache en su lugar para especificar el tamaño de caché y otras configuraciones de caché. Un umbral de tamaño de caché aproximado para los datos en 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 elementos no utilizados. |
| experimentalAutoDetectLargoEncuesta | booleano | Configura el transporte subyacente del SDK (WebChannel) para detectar automáticamente si se debe usar un sondeo largo. Esto es muy similar a experimentalForceLongPolling , pero solo usa un sondeo largo si es necesario. Después de haber tenido un valor predeterminado de false desde su creación 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 deshabilitarlo, establezca esta configuración en false y abra un problema de GitHub para compartir los problemas que lo motivaron a deshabilitar la detección automática de sondeo prolongado. Esta configuración no se puede usar en un entorno Node.js. |
| experimentalFuerzaLargaEncuesta | booleano | Obliga al transporte de red subyacente del SDK (WebChannel) a usar un sondeo largo. Cada respuesta del backend se cerrará inmediatamente después de que el backend envíe datos (de manera 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 indefinidamente. Sin embargo, el uso de esta opción provocará cierta degradación del rendimiento. Esta configuración no se puede usar con experimentalAutoDetectLongPolling y se puede eliminar en una versión futura. Si se encuentra usándolo para solucionar un problema específico de confiabilidad de la red, infórmenos al respecto en https://github.com/firebase/firebase-js-sdk/issues/1674. Esta configuración no se puede usar en un entorno Node.js. |
| experimentalLongPollingOptions | ExperimentalLongPollingOptionsExperimentalLongPollingOptions | 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 un sondeo prolongado. De lo contrario, estas opciones no tienen efecto. |
| anfitrión | cadena | El nombre de host al que conectarse. |
| ignorarUndefinedProperties | booleano | Si se deben omitir las propiedades anidadas que se establecen 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 . |
| caché local | FirestoreLocalCache | Especifica la memoria caché utilizada por el SDK. Las opciones disponibles son MemoryLocalCache y PersistentLocalCache , cada una 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, usa la configuración en el objeto FirestoreLocalCache para especificar el tamaño de la memoria caché. |
| SSL | booleano | Ya sea para usar SSL al conectarse. |
FirestoreSettings.cacheSizeBytes
NOTA: Este campo quedará obsoleto en una versión principal futura. Utilice el campo cache en su lugar para especificar el tamaño de caché y otras configuraciones de caché.
Un umbral de tamaño de caché aproximado para los datos en 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 elementos no utilizados.
Firma:
cacheSizeBytes?: number;
FirestoreSettings.experimentalAutoDetectEncuesta larga
Configura el transporte subyacente del SDK (WebChannel) para detectar automáticamente si se debe usar un sondeo largo. Esto es muy similar a experimentalForceLongPolling , pero solo usa el sondeo largo si es necesario.
Después de haber tenido un valor predeterminado de false desde su creación 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 deshabilitarlo, establezca esta configuración en false y abra un problema de GitHub para compartir los problemas que lo motivaron a deshabilitar la detección automática de sondeo prolongado.
Esta configuración no se puede usar en un entorno Node.js.
Firma:
experimentalAutoDetectLongPolling?: boolean;
FirestoreSettings.experimentalForceLongPolling
Obliga al transporte de red subyacente del SDK (WebChannel) a usar un sondeo largo. Cada respuesta del backend se cerrará inmediatamente después de que el backend envíe datos (de manera 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 indefinidamente. Sin embargo, el uso de esta opción provocará cierta degradación del rendimiento.
Esta configuración no se puede usar con experimentalAutoDetectLongPolling y se puede eliminar en una versión futura. Si se encuentra usándolo para solucionar un problema específico de confiabilidad de la red, infórmenos al respecto en https://github.com/firebase/firebase-js-sdk/issues/1674.
Esta configuración no se puede usar en un entorno 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 un sondeo prolongado. De lo contrario, estas opciones no tienen efecto.
Firma:
experimentalLongPollingOptions?: ExperimentalLongPollingOptions;
Configuración de Firestore.host
El nombre de host al que conectarse.
Firma:
host?: string;
FirestoreSettings.ignoreUndefinedProperties
Si se deben omitir las propiedades anidadas que se establecen 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 memoria 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, usa la configuración en el objeto FirestoreLocalCache para especificar el tamaño de la memoria caché.
Firma:
localCache?: FirestoreLocalCache;
Configuración de Firestore.ssl
Ya sea para usar SSL al conectarse.
Firma:
ssl?: boolean;
Especifica configuraciones personalizadas para su instancia de Cloud Firestore. Debe configurarlos antes de invocar cualquier otro método.
Firma:
export declare interface FirestoreSettings
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| cachéTamañoBytes | número | NOTA: Este campo quedará obsoleto en una versión principal futura. Utilice el campo cache en su lugar para especificar el tamaño de caché y otras configuraciones de caché. Un umbral de tamaño de caché aproximado para los datos en 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 elementos no utilizados. |
| experimentalAutoDetectLargoEncuesta | booleano | Configura el transporte subyacente del SDK (WebChannel) para detectar automáticamente si se debe usar un sondeo largo. Esto es muy similar a experimentalForceLongPolling , pero solo usa un sondeo largo si es necesario. Después de haber tenido un valor predeterminado de false desde su creación 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 deshabilitarlo, establezca esta configuración en false y abra un problema de GitHub para compartir los problemas que lo motivaron a deshabilitar la detección automática de sondeo prolongado. Esta configuración no se puede usar en un entorno Node.js. |
| experimentalFuerzaLargaEncuesta | booleano | Obliga al transporte de red subyacente del SDK (WebChannel) a usar un sondeo largo. Cada respuesta del backend se cerrará inmediatamente después de que el backend envíe datos (de manera 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 indefinidamente. Sin embargo, el uso de esta opción provocará cierta degradación del rendimiento. Esta configuración no se puede usar con experimentalAutoDetectLongPolling y se puede eliminar en una versión futura. Si se encuentra usándolo para solucionar un problema específico de confiabilidad de la red, infórmenos al respecto en https://github.com/firebase/firebase-js-sdk/issues/1674. Esta configuración no se puede usar en un entorno Node.js. |
| experimentalLongPollingOptions | ExperimentalLongPollingOptionsExperimentalLongPollingOptions | 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 un sondeo prolongado. De lo contrario, estas opciones no tienen efecto. |
| anfitrión | cadena | El nombre de host al que conectarse. |
| ignorarUndefinedProperties | booleano | Si se deben omitir las propiedades anidadas que se establecen 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 . |
| caché local | FirestoreLocalCache | Especifica la memoria caché utilizada por el SDK. Las opciones disponibles son MemoryLocalCache y PersistentLocalCache , cada una 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, usa la configuración en el objeto FirestoreLocalCache para especificar el tamaño de la memoria caché. |
| SSL | booleano | Ya sea para usar SSL al conectarse. |
FirestoreSettings.cacheSizeBytes
NOTA: Este campo quedará obsoleto en una versión principal futura. Utilice el campo cache en su lugar para especificar el tamaño de caché y otras configuraciones de caché.
Un umbral de tamaño de caché aproximado para los datos en 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 elementos no utilizados.
Firma:
cacheSizeBytes?: number;
FirestoreSettings.experimentalAutoDetectEncuesta larga
Configura el transporte subyacente del SDK (WebChannel) para detectar automáticamente si se debe usar un sondeo largo. Esto es muy similar a experimentalForceLongPolling , pero solo usa el sondeo largo si es necesario.
Después de haber tenido un valor predeterminado de false desde su creación 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 deshabilitarlo, establezca esta configuración en false y abra un problema de GitHub para compartir los problemas que lo motivaron a deshabilitar la detección automática de sondeo prolongado.
Esta configuración no se puede usar en un entorno Node.js.
Firma:
experimentalAutoDetectLongPolling?: boolean;
FirestoreSettings.experimentalForceLongPolling
Obliga al transporte de red subyacente del SDK (WebChannel) a usar un sondeo largo. Cada respuesta del backend se cerrará inmediatamente después de que el backend envíe datos (de manera 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 indefinidamente. Sin embargo, el uso de esta opción provocará cierta degradación del rendimiento.
Esta configuración no se puede usar con experimentalAutoDetectLongPolling y se puede eliminar en una versión futura. Si se encuentra usándolo para solucionar un problema específico de confiabilidad de la red, infórmenos al respecto en https://github.com/firebase/firebase-js-sdk/issues/1674.
Esta configuración no se puede usar en un entorno 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 un sondeo prolongado. De lo contrario, estas opciones no tienen efecto.
Firma:
experimentalLongPollingOptions?: ExperimentalLongPollingOptions;
Configuración de Firestore.host
El nombre de host al que conectarse.
Firma:
host?: string;
FirestoreSettings.ignoreUndefinedProperties
Si se deben omitir las propiedades anidadas que se establecen 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 memoria 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, usa la configuración en el objeto FirestoreLocalCache para especificar el tamaño de la memoria caché.
Firma:
localCache?: FirestoreLocalCache;
Configuración de Firestore.ssl
Ya sea para usar SSL al conectarse.
Firma:
ssl?: boolean;
Especifica configuraciones personalizadas para su instancia de Cloud Firestore. Debe configurarlos antes de invocar cualquier otro método.
Firma:
export declare interface FirestoreSettings
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| cachéTamañoBytes | número | NOTA: Este campo quedará obsoleto en una versión principal futura. Utilice el campo cache en su lugar para especificar el tamaño de caché y otras configuraciones de caché. Un umbral de tamaño de caché aproximado para los datos en 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 elementos no utilizados. |
| experimentalAutoDetectLargoEncuesta | booleano | Configura el transporte subyacente del SDK (WebChannel) para detectar automáticamente si se debe usar un sondeo largo. Esto es muy similar a experimentalForceLongPolling , pero solo usa un sondeo largo si es necesario. Después de haber tenido un valor predeterminado de false desde su creación 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 deshabilitarlo, establezca esta configuración en false y abra un problema de GitHub para compartir los problemas que lo motivaron a deshabilitar la detección automática de sondeo prolongado. Esta configuración no se puede usar en un entorno Node.js. |
| experimentalFuerzaLargaEncuesta | booleano | Obliga al transporte de red subyacente del SDK (WebChannel) a usar un sondeo largo. Cada respuesta del backend se cerrará inmediatamente después de que el backend envíe datos (de manera 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 indefinidamente. Sin embargo, el uso de esta opción provocará cierta degradación del rendimiento. Esta configuración no se puede usar con experimentalAutoDetectLongPolling y se puede eliminar en una versión futura. Si se encuentra usándolo para solucionar un problema específico de confiabilidad de la red, infórmenos al respecto en https://github.com/firebase/firebase-js-sdk/issues/1674. Esta configuración no se puede usar en un entorno Node.js. |
| experimentalLongPollingOptions | ExperimentalLongPollingOptionsExperimentalLongPollingOptions | 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 un sondeo prolongado. De lo contrario, estas opciones no tienen efecto. |
| anfitrión | cadena | El nombre de host al que conectarse. |
| ignorarUndefinedProperties | booleano | Si se deben omitir las propiedades anidadas que se establecen 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 . |
| caché local | FirestoreLocalCache | Especifica la memoria caché utilizada por el SDK. Las opciones disponibles son MemoryLocalCache y PersistentLocalCache , cada una 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, usa la configuración en el objeto FirestoreLocalCache para especificar el tamaño de la memoria caché. |
| SSL | booleano | Ya sea para usar SSL al conectarse. |
FirestoreSettings.cacheSizeBytes
NOTA: Este campo quedará obsoleto en una versión principal futura. Utilice el campo cache en su lugar para especificar el tamaño de caché y otras configuraciones de caché.
Un umbral de tamaño de caché aproximado para los datos en 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 elementos no utilizados.
Firma:
cacheSizeBytes?: number;
FirestoreSettings.experimentalAutoDetectEncuesta larga
Configura el transporte subyacente del SDK (WebChannel) para detectar automáticamente si se debe usar un sondeo largo. Esto es muy similar a experimentalForceLongPolling , pero solo usa el sondeo largo si es necesario.
Después de haber tenido un valor predeterminado de false desde su creación 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 deshabilitarlo, establezca esta configuración en false y abra un problema de GitHub para compartir los problemas que lo motivaron a deshabilitar la detección automática de sondeo prolongado.
Esta configuración no se puede usar en un entorno Node.js.
Firma:
experimentalAutoDetectLongPolling?: boolean;
FirestoreSettings.experimentalForceLongPolling
Obliga al transporte de red subyacente del SDK (WebChannel) a usar un sondeo largo. Cada respuesta del backend se cerrará inmediatamente después de que el backend envíe datos (de manera 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 indefinidamente. Sin embargo, el uso de esta opción provocará cierta degradación del rendimiento.
Esta configuración no se puede usar con experimentalAutoDetectLongPolling y se puede eliminar en una versión futura. Si se encuentra usándolo para solucionar un problema específico de confiabilidad de la red, infórmenos al respecto en https://github.com/firebase/firebase-js-sdk/issues/1674.
Esta configuración no se puede usar en un entorno 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 un sondeo prolongado. De lo contrario, estas opciones no tienen efecto.
Firma:
experimentalLongPollingOptions?: ExperimentalLongPollingOptions;
Configuración de Firestore.host
El nombre de host al que conectarse.
Firma:
host?: string;
FirestoreSettings.ignoreUndefinedProperties
Si se deben omitir las propiedades anidadas que se establecen 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 memoria 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, usa la configuración en el objeto FirestoreLocalCache para especificar el tamaño de la memoria caché.
Firma:
localCache?: FirestoreLocalCache;
Configuración de Firestore.ssl
Ya sea para usar SSL al conectarse.
Firma:
ssl?: boolean;