FirestoreSettings interface

Especifica configurações personalizadas para sua instância do Cloud Firestore. Você deve defini-los antes de invocar qualquer outro método.

Assinatura:

export declare interface FirestoreSettings 

Propriedades

FirestoreSettings.cacheSizeBytes

NOTA: Este campo será preterido em uma versão principal futura. Use o campo cache para especificar o tamanho do cache e outras configurações de cache.

Um limite de tamanho de cache aproximado para os dados em disco. Se o cache ultrapassar esse tamanho, o Firestore começará a remover os dados que não foram usados ​​recentemente. O tamanho não é uma garantia de que o cache ficará abaixo desse tamanho, apenas que, se o cache exceder o tamanho especificado, será feita uma tentativa de limpeza.

O valor padrão é 40 MB. O limite deve ser definido como pelo menos 1 MB e pode ser definido como CACHE_SIZE_UNLIMITED para desativar a coleta de lixo.

Assinatura:

cacheSizeBytes?: number;

FirestoreSettings.experimentalAutoDetectLongPolling

Configura o transporte subjacente do SDK (WebChannel) para detectar automaticamente se a sondagem longa deve ser usada. Isso é muito semelhante ao experimentalForceLongPolling , mas só usa sondagem longa se necessário.

Depois de ter um valor padrão false desde sua criação em 2019, o valor padrão dessa configuração foi alterado em maio de 2023 para true na v9.22.0 do Firebase JavaScript SDK. Ou seja, a detecção automática de polling longo agora está habilitada por padrão. Para desativá-lo, defina esta configuração como false e abra um problema no GitHub para compartilhar os problemas que o motivaram a desativar a detecção automática de sondagem longa.

Esta configuração não pode ser usada em um ambiente Node.js.

Assinatura:

experimentalAutoDetectLongPolling?: boolean;

FirestoreSettings.experimentalForceLongPolling

Força o transporte de rede subjacente do SDK (WebChannel) a usar sondagem longa. Cada resposta do back-end será fechada imediatamente após o back-end enviar dados (por padrão, as respostas são mantidas abertas caso o back-end tenha mais dados para enviar). Isso evita problemas de incompatibilidade com determinados proxies, software antivírus etc. que armazenam incorretamente o tráfego indefinidamente. No entanto, o uso dessa opção causará alguma degradação no desempenho.

Essa configuração não pode ser usada com experimentalAutoDetectLongPolling e pode ser removida em uma versão futura. Se você estiver usando-o para contornar um problema específico de confiabilidade de rede, informe-nos sobre isso em https://github.com/firebase/firebase-js-sdk/issues/1674.

Esta configuração não pode ser usada em um ambiente Node.js.

Assinatura:

experimentalForceLongPolling?: boolean;

FirestoreSettings.experimentalLongPollingOptions

Opções que configuram o transporte de rede subjacente do SDK (WebChannel) quando a sondagem longa é usada.

Essas opções são usadas apenas se experimentalForceLongPolling for true ou se experimentalAutoDetectLongPolling for true e a detecção automática determinar que a sondagem longa é necessária. Caso contrário, essas opções não terão efeito.

Assinatura:

experimentalLongPollingOptions?: ExperimentalLongPollingOptions;

FirestoreSettings.host

O nome do host ao qual se conectar.

Assinatura:

host?: string;

FirestoreSettings.ignoreUndefinedProperties

Se as propriedades aninhadas que são definidas como undefined durante a serialização do objeto devem ser ignoradas. Se definido como true , essas propriedades são ignoradas e não gravadas no Firestore. Se definido como false ou omitido, o SDK lançará uma exceção ao encontrar propriedades do tipo undefined .

Assinatura:

ignoreUndefinedProperties?: boolean;

FirestoreSettings.localCache

Especifica o cache usado pelo SDK. As opções disponíveis são MemoryLocalCache e PersistentLocalCache , cada um com diferentes opções de configuração.

Quando não especificado, MemoryLocalCache será usado por padrão.

NOTA: definir este campo e cacheSizeBytes ao mesmo tempo gerará uma exceção durante a inicialização do SDK. Em vez disso, use a configuração no objeto FirestoreLocalCache para especificar o tamanho do cache.

Assinatura:

localCache?: FirestoreLocalCache;

FirestoreSettings.ssl

Se deve usar SSL ao conectar.

Assinatura:

ssl?: boolean;