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
| Propriedade | Tipo | Descrição |
|---|---|---|
| cacheSizeBytes | número | NOTA: Este campo será descontinuado em uma versão principal futura. Use o campo cache para especificar o tamanho do cache e outras configurações de cache. Um limite aproximado de tamanho de cache para os dados no 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 permanecerá abaixo desse tamanho, apenas que se o cache exceder o tamanho determinado, a limpeza será tentada. 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. |
| experimentalAutoDetectLongPolling | boleano | Configura o transporte subjacente do SDK (WebChannel) para detectar automaticamente se a sondagem longa deve ser usada. Isso é muito semelhante a experimentalForceLongPolling , mas só usa sondagem longa se necessário. Depois de ter um valor padrão false desde seu início 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 pesquisas longas 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 motivaram você a desabilitar a detecção automática de pesquisa longa. Essa configuração não pode ser usada em um ambiente Node.js. |
| experimentalForceLongPolling | boleano | Força o transporte de rede subjacente do SDK (WebChannel) a usar sondagem longa. Cada resposta do backend será fechada imediatamente após o backend enviar dados (por padrão, as respostas são mantidas abertas caso o backend tenha mais dados para enviar). Isso evita problemas de incompatibilidade com determinados proxies, software antivírus, etc. que armazenam incorretamente o tráfego em buffer indefinidamente. O uso desta opção causará alguma degradação no desempenho. Esta configuração não pode ser usada com experimentalAutoDetectLongPolling e pode ser removida em uma versão futura. Se você estiver usando-o para solucionar um problema específico de confiabilidade de rede, conte-nos sobre isso em https://github.com/firebase/firebase-js-sdk/issues/1674. Essa configuração não pode ser usada em um ambiente Node.js. |
| experimentalLongPollingOptions | ExperimentalLongPollingOptions | Opções que configuram o transporte de rede subjacente do SDK (WebChannel) quando a sondagem longa é usada. Essas opções serão usadas apenas se experimentalForceLongPolling for verdadeiro ou se experimentalAutoDetectLongPolling for verdadeiro e a detecção automática determinar que a sondagem longa era necessária. Caso contrário, estas opções não terão efeito. |
| hospedar | corda | O nome do host ao qual se conectar. |
| ignoreUndefinedProperties | boleano | Se devem ser ignoradas propriedades aninhadas definidas como undefined durante a serialização do objeto. Se definidas como true , essas propriedades serão ignoradas e não serão gravadas no Firestore. Se definido como false ou omitido, o SDK lança uma exceção quando encontra propriedades do tipo undefined . |
| localCache | FirestoreLocalCache | Especifica o cache usado pelo SDK. As opções disponíveis são MemoryLocalCache e PersistentLocalCache , cada uma 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. |
| SSL | boleano | Se deve usar SSL ao conectar. |
FirestoreSettings.cacheSizeBytes
NOTA: Este campo será descontinuado em uma versão principal futura. Use o campo cache para especificar o tamanho do cache e outras configurações de cache.
Um limite aproximado de tamanho de cache para os dados no 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 permanecerá abaixo desse tamanho, apenas que se o cache exceder o tamanho determinado, a limpeza será tentada.
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 seu início 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 pesquisas longas 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 motivaram você a desativar a detecção automática de pesquisa longa.
Essa 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 backend será fechada imediatamente após o backend enviar dados (por padrão, as respostas são mantidas abertas caso o backend tenha mais dados para enviar). Isso evita problemas de incompatibilidade com determinados proxies, software antivírus, etc. que armazenam incorretamente o tráfego em buffer indefinidamente. O uso desta opção causará alguma degradação no desempenho.
Esta configuração não pode ser usada com experimentalAutoDetectLongPolling e pode ser removida em uma versão futura. Se você estiver usando-o para solucionar um problema específico de confiabilidade de rede, conte-nos sobre isso em https://github.com/firebase/firebase-js-sdk/issues/1674.
Essa 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 serão usadas apenas se experimentalForceLongPolling for verdadeiro ou se experimentalAutoDetectLongPolling for verdadeiro e a detecção automática determinar que a sondagem longa era necessária. Caso contrário, estas 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 devem ser ignoradas propriedades aninhadas definidas como undefined durante a serialização do objeto. Se definido como true , essas propriedades serão ignoradas e não serão gravadas no Firestore. Se definido como false ou omitido, o SDK lança uma exceção quando encontra 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;