Specifica le configurazioni personalizzate per la tua istanza Cloud Firestore. È necessario impostarli prima di invocare qualsiasi altro metodo.
Firma:
export declare interface FirestoreSettings
Proprietà
| Proprietà | Tipo | Descrizione |
|---|---|---|
| cacheSizeBytes | numero | NOTA: questo campo sarà obsoleto in una futura versione principale. Utilizza invece il campo cache per specificare la dimensione della cache e altre configurazioni della cache. Una soglia approssimativa per la dimensione della cache per i dati su disco. Se la cache supera queste dimensioni, Firestore inizierà a rimuovere i dati che non sono stati utilizzati di recente. La dimensione non garantisce che la cache rimanga al di sotto di tale dimensione, ma solo che se la cache supera la dimensione specificata, verrà tentata la pulizia. Il valore predefinito è 40 MB. La soglia deve essere impostata su almeno 1 MB e può essere impostata su CACHE_SIZE_UNLIMITED per disabilitare la garbage collection. |
| sperimentaleAutoDetectLongPolling | booleano | Configura il trasporto sottostante dell'SDK (WebChannel) per rilevare automaticamente se è necessario utilizzare il polling lungo. È molto simile a experimentalForceLongPolling , ma utilizza il polling lungo solo se necessario. Dopo aver avuto un valore predefinito false sin dal suo inizio nel 2019, il valore predefinito di questa impostazione è stato modificato in maggio 2023 in true nella versione 9.22.0 dell'SDK JavaScript di Firebase. Cioè, il rilevamento automatico del polling lungo è ora abilitato per impostazione predefinita. Per disabilitarlo, imposta questa impostazione su false e apri un problema su GitHub per condividere i problemi che ti hanno motivato a disabilitare il rilevamento automatico del polling lungo. Questa impostazione non può essere utilizzata in un ambiente Node.js. |
| sperimentaleForceLongPolling | booleano | Forza il trasporto di rete sottostante dell'SDK (WebChannel) a utilizzare il polling lungo. Ogni risposta dal backend verrà chiusa immediatamente dopo che il backend ha inviato i dati (per impostazione predefinita le risposte vengono mantenute aperte nel caso in cui il backend abbia più dati da inviare). Ciò evita problemi di incompatibilità con alcuni proxy, software antivirus, ecc. che bufferizzano erroneamente il traffico a tempo indeterminato. L'uso di questa opzione causerà tuttavia un certo degrado delle prestazioni. Questa impostazione non può essere utilizzata con experimentalAutoDetectLongPolling e potrebbe essere rimossa in una versione futura. Se ti ritrovi a utilizzarlo per risolvere uno specifico problema di affidabilità della rete, comunicacelo in https://github.com/firebase/firebase-js-sdk/issues/1674. Questa impostazione non può essere utilizzata in un ambiente Node.js. |
| sperimentaleLongPollingOptions | Opzioni sperimentali di polling lungo | Opzioni che configurano il trasporto di rete sottostante dell'SDK (WebChannel) quando viene utilizzato il polling lungo. Queste opzioni vengono utilizzate solo se experimentalForceLongPolling è vero o se experimentalAutoDetectLongPolling è vero e il rilevamento automatico ha determinato che era necessario il polling lungo. Altrimenti, queste opzioni non hanno alcun effetto. |
| ospite | corda | Il nome host a cui connettersi. |
| ignoraProprietàNonDefinite | booleano | Indica se ignorare le proprietà nidificate impostate su undefined durante la serializzazione dell'oggetto. Se impostate su true , queste proprietà vengono ignorate e non scritte su Firestore. Se impostato su false o omesso, l'SDK genera un'eccezione quando rileva proprietà di tipo undefined . |
| localCache | FirestoreLocalCache | Specifica la cache utilizzata dall'SDK. Le opzioni disponibili sono MemoryLocalCache e PersistentLocalCache , ciascuna con diverse opzioni di configurazione. Se non specificato, MemoryLocalCache verrà utilizzato per impostazione predefinita. NOTA: l'impostazione contemporanea di questo campo e cacheSizeBytes genererà un'eccezione durante l'inizializzazione dell'SDK. Utilizzare invece la configurazione nell'oggetto FirestoreLocalCache per specificare la dimensione della cache. |
| SSL | booleano | Se utilizzare SSL durante la connessione. |
FirestoreSettings.cacheSizeBytes
NOTA: questo campo sarà obsoleto in una futura versione principale. Utilizza invece il campo cache per specificare la dimensione della cache e altre configurazioni della cache.
Una soglia approssimativa per la dimensione della cache per i dati su disco. Se la cache supera queste dimensioni, Firestore inizierà a rimuovere i dati che non sono stati utilizzati di recente. La dimensione non garantisce che la cache rimanga al di sotto di tale dimensione, ma solo che se la cache supera la dimensione specificata, verrà tentata la pulizia.
Il valore predefinito è 40 MB. La soglia deve essere impostata su almeno 1 MB e può essere impostata su CACHE_SIZE_UNLIMITED per disabilitare la garbage collection.
Firma:
cacheSizeBytes?: number;
FirestoreSettings.experimentalAutoDetectLongPolling
Configura il trasporto sottostante dell'SDK (WebChannel) per rilevare automaticamente se è necessario utilizzare il polling lungo. Questo è molto simile a experimentalForceLongPolling , ma utilizza il polling lungo solo se necessario.
Dopo aver avuto un valore predefinito false sin dal suo inizio nel 2019, il valore predefinito di questa impostazione è stato modificato in maggio 2023 in true nella versione 9.22.0 dell'SDK JavaScript di Firebase. Cioè, il rilevamento automatico del polling lungo è ora abilitato per impostazione predefinita. Per disabilitarlo, imposta questa impostazione su false e apri una discussione su GitHub per condividere i problemi che ti hanno motivato a disabilitare il rilevamento automatico del polling lungo.
Questa impostazione non può essere utilizzata in un ambiente Node.js.
Firma:
experimentalAutoDetectLongPolling?: boolean;
FirestoreSettings.experimentalForceLongPolling
Forza il trasporto di rete sottostante dell'SDK (WebChannel) a utilizzare il polling lungo. Ogni risposta dal backend verrà chiusa immediatamente dopo che il backend ha inviato i dati (per impostazione predefinita le risposte vengono mantenute aperte nel caso in cui il backend abbia più dati da inviare). Ciò evita problemi di incompatibilità con alcuni proxy, software antivirus, ecc. che bufferizzano erroneamente il traffico a tempo indeterminato. L'uso di questa opzione causerà tuttavia un certo degrado delle prestazioni.
Questa impostazione non può essere utilizzata con experimentalAutoDetectLongPolling e potrebbe essere rimossa in una versione futura. Se ti ritrovi a utilizzarlo per risolvere uno specifico problema di affidabilità della rete, comunicacelo in https://github.com/firebase/firebase-js-sdk/issues/1674.
Questa impostazione non può essere utilizzata in un ambiente Node.js.
Firma:
experimentalForceLongPolling?: boolean;
FirestoreSettings.experimentalLongPollingOptions
Opzioni che configurano il trasporto di rete sottostante dell'SDK (WebChannel) quando viene utilizzato il polling lungo.
Queste opzioni vengono utilizzate solo se experimentalForceLongPolling è vero o se experimentalAutoDetectLongPolling è vero e il rilevamento automatico ha determinato che era necessario il polling lungo. Altrimenti, queste opzioni non hanno alcun effetto.
Firma:
experimentalLongPollingOptions?: ExperimentalLongPollingOptions;
FirestoreSettings.host
Il nome host a cui connettersi.
Firma:
host?: string;
FirestoreSettings.ignoreUnfineProperties
Indica se ignorare le proprietà nidificate impostate su undefined durante la serializzazione dell'oggetto. Se impostato su true , queste proprietà vengono ignorate e non scritte su Firestore. Se impostato su false o omesso, l'SDK genera un'eccezione quando rileva proprietà di tipo undefined .
Firma:
ignoreUndefinedProperties?: boolean;
FirestoreSettings.localCache
Specifica la cache utilizzata dall'SDK. Le opzioni disponibili sono MemoryLocalCache e PersistentLocalCache , ciascuno con diverse opzioni di configurazione.
Se non specificato, MemoryLocalCache verrà utilizzato per impostazione predefinita.
NOTA: l'impostazione contemporanea di questo campo e cacheSizeBytes genererà un'eccezione durante l'inizializzazione dell'SDK. Utilizzare invece la configurazione nell'oggetto FirestoreLocalCache per specificare la dimensione della cache.
Firma:
localCache?: FirestoreLocalCache;
FirestoreSettings.ssl
Se utilizzare SSL durante la connessione.
Firma:
ssl?: boolean;