Especifica as configurações personalizadas para sua instância do Cloud Firestore. É necessário defini-los antes de invocar qualquer outro método.
Assinatura:
export declare interface FirestoreSettings
Propriedades
| Propriedade | Tipo | Descrição |
|---|---|---|
| cacheSizeBytes (em inglês) | number | OBSERVAÇÃO: este campo será descontinuado em uma versão principal futura. Use o campo cache para especificar o tamanho e outras configurações do cache.Um limite aproximado de tamanho de cache 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 garante que o cache permaneça abaixo dele, apenas que se ele exceder o tamanho especificado, haverá uma tentativa de limpeza.O valor padrão é 40 MB. O limite precisa ser definido como pelo menos 1 MB e pode ser definido como CACHE_SIZE_UNLIMITED para desativar a coleta de lixo. |
| experimentalAutoDetectLongPolling | booleano | Configura o transporte subjacente do SDK (WebChannel) para detectar automaticamente se a pesquisa longa precisa ser usada. Isso é muito semelhante ao experimentalForceLongPolling, mas só usa pesquisas longas se necessário.Depois de ter um valor padrão de false desde o lançamento em 2019, o valor padrão dessa configuração mudou em maio de 2023 para true na v9.22.0 do SDK do Firebase para JavaScript. Ou seja, a detecção automática de sondagem longa agora está ativada por padrão. Para desativá-la, defina essa configuração como false e abra um problema do 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. |
| experimentalForceLongPolling | booleano | Força o transporte de rede subjacente (WebChannel) do SDK a usar pesquisa longa. Cada resposta do back-end será fechada imediatamente após o back-end enviar os 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, softwares antivírus etc. que armazenam o tráfego em buffer de forma incorreta indefinidamente. O uso dessa opção vai prejudicar o desempenho.Essa configuração não pode ser usada com o experimentalAutoDetectLongPolling e poderá ser removida em uma versão futura. Se você estiver usando essa ferramenta para contornar um problema específico de confiabilidade de rede, acesse https://github.com/firebase/firebase-js-sdk/issues/1674.Essa configuração não pode ser usada em um ambiente Node.js. |
| experimentalLongPollingOptions (em inglês) | ExperimentalLongPollingOptions (em inglês) | Opções que configuram o transporte de rede subjacente do SDK (WebChannel) quando a pesquisa longa é usada.Essas opções são usadas apenas se experimentalForceLongPolling for verdadeiro ou se experimentalAutoDetectLongPolling for verdadeiro e a detecção automática determinar que a pesquisa longa foi necessária. Caso contrário, essas opções não terão efeito. |
| host | string | O nome do host ao qual se conectar. |
| ignoreUndefineProperties (link em inglês) | booleano | Define se as propriedades aninhadas serão ignoradas, 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 vai gerar uma exceção quando encontrar propriedades do tipo undefined. |
| localCache (em inglês) | FirestoreLocalCache | Especifica o cache usado pelo SDK. As opções disponíveis são MemoryLocalCache e PersistentLocalCache, cada uma com opções de configuração diferentes.Quando não for especificada, MemoryLocalCache será usada por padrão.OBSERVAÇÃO: definir este campo e cacheSizeBytes ao mesmo tempo vai gerar exceções durante a inicialização do SDK. Em vez disso, use a configuração no objeto FirestoreLocalCache para especificar o tamanho do cache. |
| ssl | booleano | Indica se o SSL será usado durante a conexão. |
FirestoreSettings.cacheSizeBytes
OBSERVAÇÃO: este campo terá o uso suspenso em uma versão principal futura. Use o campo cache para especificar o tamanho e outras configurações do cache.
Um limite aproximado de tamanho de cache 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 garante que o cache permanecerá abaixo desse tamanho, mas uma tentativa de limpeza se o cache exceder o tamanho especificado.
O valor padrão é 40 MB. O limite precisa 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 pesquisa longa precisa ser usada. Esse processo é muito semelhante ao experimentalForceLongPolling, mas usa a pesquisa longa apenas quando necessário.
Depois de ter tido um valor padrão de false desde o lançamento em 2019, o valor padrão dessa configuração mudou em maio de 2023 para true na v9.22.0 do SDK do Firebase para JavaScript. Ou seja, a detecção automática de sondagem longa agora está ativada por padrão. Para desativá-la, defina essa configuração como false e abra um problema do GitHub para informar os problemas que motivaram você a desativar a detecção automática de pesquisas longas.
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 (WebChannel) do SDK a usar pesquisa longa. Cada resposta do back-end será fechada imediatamente após o back-end enviar os 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, softwares antivírus etc. que armazenam o tráfego em buffer de forma incorreta indefinidamente. No entanto, o uso dessa opção causará alguma degradação do desempenho.
Essa configuração não pode ser usada com experimentalAutoDetectLongPolling e poderá ser removida em uma versão futura. Se você estiver usando esse recurso para contornar um problema específico de confiabilidade da rede, informe-nos 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 (WebChannel) do SDK quando a pesquisa longa é usada.
Essas opções são usadas apenas se experimentalForceLongPolling for verdadeiro ou se experimentalAutoDetectLongPolling for verdadeiro e a detecção automática determinou que a pesquisa longa era 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.ignoreUndefinidoProperties
Define se as propriedades aninhadas serão ignoradas, 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 vai gerar uma exceção quando 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 uma com opções de configuração diferentes.
Quando não for especificado, MemoryLocalCache será usado por padrão.
OBSERVAÇÃO: definir este campo e cacheSizeBytes ao mesmo tempo vai 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
Indica se o SSL será usado durante a conexão.
Assinatura:
ssl?: boolean;