@firebase/firestore

Funzioni

Funzione	Descrizione
funzione(app, ...)
getFirestore(app)	Restituisce l'istanza Firestore predefinita esistente associata alla FirebaseApp fornita . Se non esiste alcuna istanza, inizializza una nuova istanza con le impostazioni predefinite.
getFirestore(app, ID database)	(BETA) Restituisce l'istanza Firestore denominata esistente associata alla FirebaseApp fornita . Se non esiste alcuna istanza, inizializza una nuova istanza con le impostazioni predefinite.
inizializzareFirestore(app, impostazioni, databaseId)	Inizializza una nuova istanza di Firestore con le impostazioni fornite. Può essere chiamato solo prima di qualsiasi altra funzione, incluso getFirestore() . Se le impostazioni personalizzate sono vuote, questa funzione equivale a chiamare getFirestore() .
funzione(firestore, ...)
clearIndexedDbPersistence(firestore)	Cancella la memoria persistente. Ciò include le scritture in sospeso e i documenti memorizzati nella cache. Deve essere chiamato mentre l'istanza Firestore non è avviata (dopo la chiusura dell'app o la prima inizializzazione dell'app). All'avvio, questa funzione deve essere chiamata prima di altre funzioni (diverse da inizializzareFirestore() o getFirestore() )). Se l'istanza Firestore è ancora in esecuzione, la promessa verrà rifiutata con il codice di errore failed-precondition . Nota: clearIndexedDbPersistence() è destinato principalmente ad aiutare a scrivere test affidabili che utilizzano Cloud Firestore. Utilizza un meccanismo efficiente per eliminare i dati esistenti ma non tenta di sovrascrivere in modo sicuro o altrimenti rendere irrecuperabili i dati memorizzati nella cache. Per le applicazioni sensibili alla divulgazione dei dati memorizzati nella cache tra le sessioni utente, consigliamo vivamente di non abilitare affatto la persistenza.
raccolta(firestore, percorso, pathSegments)	Ottiene un'istanza CollectionReference che fa riferimento alla raccolta nel percorso assoluto specificato.
collectionGroup(firestore, collectionId)	Crea e restituisce una nuova istanza Query che include tutti i documenti nel database contenuti in una raccolta o sottoraccolta con il collectionId specificato.
connectFirestoreEmulator(firestore, host, porta, opzioni)	Modifica questa istanza per comunicare con l'emulatore Cloud Firestore. Nota: questo deve essere chiamato prima che questa istanza venga utilizzata per eseguire qualsiasi operazione.
disabilitaRete(firestore)	Disabilita l'utilizzo della rete per questa istanza. Può essere riattivato tramite EnableNetwork() . Mentre la rete è disabilitata, qualsiasi listener di snapshot, chiamata getDoc() o getDocs() restituirà risultati dalla cache e qualsiasi operazione di scrittura verrà accodata fino al ripristino della rete.
doc(firestore, percorso, percorsiSegmenti)	Ottiene un'istanza DocumentReference che fa riferimento al documento nel percorso assoluto specificato.
abilitaIndexedDbPersistence(firestore, persistenceSettings)	Tenta di abilitare l'archiviazione persistente, se possibile. In caso di fallimento, enableIndexedDbPersistence() rifiuterà la promessa o genererà un'eccezione. Esistono diversi motivi per cui ciò può fallire, che possono essere identificati dal code sull'errore. * precondizione non riuscita: l'app è già aperta in un'altra scheda del browser. * non implementato: il browser non è compatibile con l'implementazione della persistenza offline. Tieni presente che anche dopo un errore, l'istanza Firestore rimarrà utilizzabile, tuttavia la persistenza offline sarà disabilitata. Nota: enableIndexedDbPersistence() deve essere chiamato prima di qualsiasi altra funzione (diversa da inizializzareFirestore() , getFirestore() o clearIndexedDbPersistence() . La persistenza non può essere utilizzata in un ambiente Node.js.
abilitaMultiTabIndexedDbPersistence(firestore)	Tenta di abilitare l'archiviazione persistente su più schede, se possibile. Se abilitato in tutte le schede, tutte le operazioni condividono l'accesso alla persistenza locale, inclusa l'esecuzione condivisa di query e aggiornamenti di documenti locali con compensazione della latenza in tutte le istanze connesse. In caso di fallimento, enableMultiTabIndexedDbPersistence() rifiuterà la promessa o genererà un'eccezione. Esistono diversi motivi per cui ciò può fallire, che possono essere identificati dal code sull'errore. * precondizione non riuscita: l'app è già aperta in un'altra scheda del browser e la multischeda non è abilitata. * non implementato: il browser non è compatibile con l'implementazione della persistenza offline. Tieni presente che anche dopo un errore, l'istanza Firestore rimarrà utilizzabile, tuttavia la persistenza offline sarà disabilitata.
abilitaRete(firestore)	Riabilita l'uso della rete per questa istanza Firestore dopo una precedente chiamata a DisableNetwork() .
getPersistentCacheIndexManager(firestore)	Restituisce il gestore dell'indice PersistentCache utilizzato dall'oggetto Firestore specificato. L'istanza PersistentCacheIndexManager o null se l'archiviazione persistente locale non è in uso.
loadBundle(firestore, bundleData)	Carica un bundle Firestore nella cache locale.
denominataQuery(firestore, nome)	Legge una query Firestore dalla cache locale, identificata dal nome fornito. Le query denominate vengono raggruppate in bundle sul lato server (insieme ai documenti risultanti) e caricate nella cache locale utilizzando loadBundle . Una volta nella cache locale, utilizza questo metodo per estrarre una query per nome.
onSnapshotsInSync(firestore, osservatore)	Allega un ascoltatore per un evento di snapshot sincronizzati. L'evento snapshot in sincronia indica che tutti i listener interessati da una determinata modifica sono stati attivati, anche se una singola modifica generata dal server influisce su più listener. NOTA: l'evento snapshot in sincronia indica solo che gli ascoltatori sono sincronizzati tra loro, ma non si riferisce al fatto che tali snapshot siano sincronizzati con il server. Utilizza SnapshotMetadata nei singoli ascoltatori per determinare se uno snapshot proviene dalla cache o dal server.
onSnapshotsInSync(firestore, onSync)	Allega un ascoltatore per un evento di snapshot sincronizzati. L'evento snapshot in sincronia indica che tutti i listener interessati da una determinata modifica sono stati attivati, anche se una singola modifica generata dal server influisce su più listener. NOTA: l'evento snapshot in sincronia indica solo che gli ascoltatori sono sincronizzati tra loro, ma non si riferisce al fatto che tali snapshot siano sincronizzati con il server. Utilizza SnapshotMetadata nei singoli ascoltatori per determinare se uno snapshot proviene dalla cache o dal server.
runTransaction(firestore, updateFunction, opzioni)	Esegue la updateFunction specificata e quindi tenta di confermare le modifiche applicate all'interno della transazione. Se un documento letto all'interno della transazione è cambiato, Cloud Firestore riprova a utilizzare updateFunction . Se il commit non riesce dopo 5 tentativi, la transazione fallisce. Il numero massimo di scritture consentite in una singola transazione è 500.
setIndexConfiguration(firestore, configurazione)	(BETA) Configura l'indicizzazione per l'esecuzione di query locali. Qualsiasi configurazione dell'indice precedente viene sovrascritta. La Promise si risolve una volta mantenuta la configurazione dell'indice. Le voci dell'indice stesse vengono create in modo asincrono. È possibile continuare a utilizzare le query che richiedono l'indicizzazione anche se gli indici non sono ancora disponibili. L'esecuzione della query inizierà automaticamente utilizzando l'indice una volta scritte le voci dell'indice. Gli indici sono supportati solo con la persistenza IndexedDb. Se IndexedDb non è abilitato, qualsiasi configurazione dell'indice viene ignorata.
setIndexConfiguration(firestore, json)	(BETA) Configura l'indicizzazione per l'esecuzione di query locali. Qualsiasi configurazione dell'indice precedente viene sovrascritta. La Promise si risolve una volta mantenuta la configurazione dell'indice. Le voci dell'indice stesse vengono create in modo asincrono. È possibile continuare a utilizzare le query che richiedono l'indicizzazione anche se gli indici non sono ancora disponibili. L'esecuzione della query inizierà automaticamente utilizzando l'indice una volta scritte le voci dell'indice. Gli indici sono supportati solo con la persistenza IndexedDb. Richiamare enableIndexedDbPersistence() o enableMultiTabIndexedDbPersistence() prima di impostare una configurazione dell'indice. Se IndexedDb non è abilitato, qualsiasi configurazione dell'indice viene ignorata. Il metodo accetta il formato JSON esportato dalla CLI Firebase ( firebase firestore:indexes ). Se il formato JSON non è valido, questo metodo genera un errore.
terminare(firestore)	Termina l'istanza Firestore fornita. Dopo aver chiamato terminate() è possibile utilizzare solo la funzione clearIndexedDbPersistence() . Qualsiasi altra funzione genererà un FirestoreError . Per riavviare dopo la terminazione, crea una nuova istanza di FirebaseFirestore con getFirestore() . La terminazione non annulla alcuna scrittura in sospeso e qualsiasi promessa in attesa di risposta dal server non verrà risolta. Se hai abilitato la persistenza, la prossima volta che avvii questa istanza, riprenderà a inviare queste scritture al server. Nota: in circostanze normali, la chiamata terminate() non è necessaria. Questa funzione è utile solo quando vuoi forzare questa istanza a rilasciare tutte le sue risorse o in combinazione con clearIndexedDbPersistence() per garantire che tutto lo stato locale venga distrutto tra le esecuzioni dei test.
waitForPendingWrites(firestore)	Attende fino a quando tutte le scritture attualmente in sospeso per l'utente attivo non sono state riconosciute dal backend. La promessa restituita si risolve immediatamente se non sono presenti scritture in sospeso. In caso contrario, la promessa attende tutte le scritture eseguite in precedenza (incluse quelle scritte in una sessione precedente dell'app), ma non attende le scritture aggiunte dopo la chiamata della funzione. Se vuoi attendere ulteriori scritture, chiama di nuovo waitForPendingWrites() . Eventuali promesse waitForPendingWrites() in sospeso vengono rifiutate durante le modifiche dell'utente.
writeBatch(firestore)	Crea un batch di scrittura, utilizzato per eseguire più scritture come un'unica operazione atomica. Il numero massimo di scritture consentite in un singolo WriteBatch è 500. A differenza delle transazioni, i batch di scrittura vengono mantenuti offline e pertanto sono preferibili quando non è necessario condizionare le scritture sui dati letti.
funzione()
contare()	Crea un oggetto AggregateField che può essere utilizzato per calcolare il conteggio dei documenti nel set di risultati di una query.
eliminacampo()	Restituisce una sentinella da utilizzare con updateDoc() o setDoc() con {merge: true} per contrassegnare un campo per l'eliminazione.
IDdocumento()	Restituisce una sentinella speciale FieldPath per fare riferimento all'ID di un documento. Può essere utilizzato nelle query per ordinare o filtrare in base all'ID del documento.
getFirestore()	Restituisce l'istanza Firestore predefinita esistente associata al FirebaseApp predefinito . Se non esiste alcuna istanza, inizializza una nuova istanza con le impostazioni predefinite.
memoriaEagerGarbageCollector()	Crea un'istanza di MemoryEagerGarbageCollector . Questo è anche il Garbage Collector predefinito, a meno che non sia specificato diversamente in modo esplicito.
persistentMultipleTabManager()	Crea un'istanza di PersistentMultipleTabManager .
serverTimestamp()	Restituisce una sentinella utilizzata con setDoc() o updateDoc() per includere un timestamp generato dal server nei dati scritti.
funzione(IDdatabase, ...)
getFirestore(IDdatabase)	(BETA) Restituisce l'istanza Firestore denominata esistente associata alla FirebaseApp predefinita . Se non esiste alcuna istanza, inizializza una nuova istanza con le impostazioni predefinite.
funzione(elementi, ...)
arrayRimuovi(elementi)	Restituisce un valore speciale che può essere utilizzato con setDoc() o che indica al server di rimuovere gli elementi specificati da qualsiasi valore dell'array già esistente sul server. Tutte le istanze di ciascun elemento specificato verranno rimosse dall'array. Se il campo da modificare non è già un array verrà sovrascritto con un array vuoto.
arrayUnione(elementi)	Restituisce un valore speciale che può essere utilizzato con setDoc() o updateDoc() che dice al server di unire gli elementi specificati con qualsiasi valore dell'array già esistente sul server. Ogni elemento specificato che non esiste già nell'array verrà aggiunto alla fine. Se il campo da modificare non è già un array verrà sovrascritto con un array contenente esattamente gli elementi specificati.
funzione(campo, ...)
media(campo)	Crea un oggetto AggregateField che può essere utilizzato per calcolare la media di un campo specificato su un intervallo di documenti nel set di risultati di una query.
somma(campo)	Crea un oggetto AggregateField che può essere utilizzato per calcolare la somma di un campo specificato su un intervallo di documenti nel set di risultati di una query.
funzione(percorsocampo, ...)
ordinePer(campoPercorso, direzioneStr)	Crea un oggetto QueryOrderByConstraint che ordina il risultato della query in base al campo specificato, facoltativamente in ordine decrescente anziché crescente. Nota: i documenti che non contengono il campo specificato non saranno presenti nel risultato della query.
dove(percorsocampo, opStr, valore)	Crea un oggetto QueryFieldFilterConstraint che impone che i documenti contengano il campo specificato e che il valore soddisfi il vincolo di relazione fornito.
funzione(valoricampo, ...)
endAt(valoricampo)	Crea un oggetto QueryEndAtConstraint che modifica il set di risultati in modo che termini nei campi forniti rispetto all'ordine della query. L'ordine dei valori dei campi deve corrispondere all'ordine delle clausole dell'ordine della query.
endBefore(valoricampo)	Crea un oggetto QueryEndAtConstraint che modifica il set di risultati in modo che termini prima dei campi forniti rispetto all'ordine della query. L'ordine dei valori dei campi deve corrispondere all'ordine delle clausole dell'ordine della query.
startAfter(valoricampo)	Crea un oggetto QueryStartAtConstraint che modifica il set di risultati in modo che inizi dopo i campi forniti rispetto all'ordine della query. L'ordine dei valori dei campi deve corrispondere all'ordine delle clausole dell'ordine della query.
inizioAt(valoricampo)	Crea un oggetto QueryStartAtConstraint che modifica il set di risultati in modo che inizi dai campi forniti rispetto all'ordine della query. L'ordine dei valori dei campi deve corrispondere all'ordine delle clausole dell'ordine della query.
funzione(Gestioneindice, ...)
deleteAllPersistentCacheIndexes(indexManager)	Rimuove tutti gli indici della cache persistente. Tieni presente che questa funzione eliminerà anche gli indici generati da setIndexConfiguration() , che è deprecato.
disabilitaPersistentCacheIndexAutoCreation(indexManager)	Interrompe la creazione automatica degli indici della cache persistente per l'esecuzione delle query locali. Gli indici che sono stati creati chiamando enablePersistentCacheIndexAutoCreation() continuano ad avere effetto.
abilitaPersistentCacheIndexAutoCreation(indexManager)	Consente all'SDK di creare automaticamente indici di cache persistenti per l'esecuzione di query locali quando l'SDK ritiene che gli indici di cache possano contribuire a migliorare le prestazioni. Questa funzionalità è disabilitata per impostazione predefinita.
funzione(sinistra, ...)
aggregateFieldEqual(sinistra, destra)	Confronta due "AggregateField ` istanze di uguaglianza.
aggregateQuerySnapshotEqual(sinistra, destra)	Confronta due istanze AggregateQuerySnapshot per verificarne l'uguaglianza. Due istanze AggregateQuerySnapshot sono considerate "uguali" se hanno query sottostanti che confrontano uguali e gli stessi dati.
queryEqual(sinistra, destra)	Restituisce true se le query fornite puntano alla stessa raccolta e applicano gli stessi vincoli.
refEqual(sinistra, destra)	Restituisce vero se i riferimenti forniti sono uguali.
snapshotUguale(sinistra, destra)	Restituisce vero se gli snapshot forniti sono uguali.
funzione(limite, ...)
limite (limite)	Crea un QueryLimitConstraint che restituisce solo i primi documenti corrispondenti.
limite all'ultimo(limite)	Crea un QueryLimitConstraint che restituisce solo gli ultimi documenti corrispondenti. È necessario specificare almeno una clausola orderBy per le query limitToLast , altrimenti verrà generata un'eccezione durante l'esecuzione.
funzione(livellolog, ...)
setLogLevel(logLevel)	Imposta il livello di dettaglio dei log di Cloud Firestore (debug, errore o silenzioso).
funzione(n, ...)
incremento(n)	Restituisce un valore speciale che può essere utilizzato con setDoc() o updateDoc() che dice al server di incrementare il valore corrente del campo del valore specificato. Se l'operando o il valore del campo corrente utilizzano la precisione in virgola mobile, tutta l'aritmetica segue la semantica IEEE 754. Se entrambi i valori sono interi, anche i valori esterni all'intervallo di numeri sicuri di JavaScript (da Number.MIN_SAFE_INTEGER a Number.MAX_SAFE_INTEGER ) sono soggetti a perdita di precisione. Inoltre, una volta elaborate dal backend Firestore, tutte le operazioni sugli interi vengono limitate tra -2^63 e 2^63-1. Se il valore del campo corrente non è di tipo number o se il campo non esiste ancora, la trasformazione imposta il campo sul valore specificato.
funzione(query, ...)
getAggregateFromServer(query, aggregateSpec)	Calcola le aggregazioni specificate sui documenti nel set di risultati della query specificata senza scaricare effettivamente i documenti. L'utilizzo di questa funzione per eseguire aggregazioni è efficiente perché vengono scaricati solo i valori di aggregazione finali, non i dati dei documenti. Questa funzione può eseguire aggregazioni di documenti nei casi in cui il set di risultati è eccessivamente grande per essere scaricato interamente (migliaia di documenti). Il risultato ricevuto dal server viene presentato, inalterato, senza considerare alcuno stato locale. Ciò significa che i documenti nella cache locale non vengono presi in considerazione, né vengono prese in considerazione le modifiche locali non ancora sincronizzate con il server. I risultati scaricati in precedenza, se presenti, non vengono utilizzati. Ogni invocazione di questa funzione comporta necessariamente un viaggio di andata e ritorno verso il server.
getCountFromServer(query)	Calcola il numero di documenti nel set di risultati della query specificata senza effettivamente scaricare i documenti. Utilizzare questa funzione per contare i documenti è efficiente perché viene scaricato solo il conteggio finale, non i dati dei documenti. Questa funzione può contare i documenti nei casi in cui il set di risultati è eccessivamente grande per essere scaricato interamente (migliaia di documenti). Il risultato ricevuto dal server viene presentato, inalterato, senza considerare alcuno stato locale. Ciò significa che i documenti nella cache locale non vengono presi in considerazione, né vengono prese in considerazione le modifiche locali non ancora sincronizzate con il server. I risultati scaricati in precedenza, se presenti, non vengono utilizzati. Ogni invocazione di questa funzione comporta necessariamente un viaggio di andata e ritorno verso il server.
getDocs(query)	Esegue la query e restituisce i risultati come QuerySnapshot . Nota: getDocs() tenta di fornire dati aggiornati quando possibile attendendo i dati dal server, ma potrebbe restituire dati memorizzati nella cache o fallire se sei offline e il server non può essere raggiunto. Per specificare questo comportamento, richiama getDocsFromCache() o getDocsFromServer() .
getDocsFromCache(query)	Esegue la query e restituisce i risultati come QuerySnapshot dalla cache. Restituisce un set di risultati vuoto se nessun documento corrispondente alla query è attualmente memorizzato nella cache.
getDocsFromServer(query)	Esegue la query e restituisce i risultati come QuerySnapshot dal server. Restituisce un errore se la rete non è disponibile.
onSnapshot(query, osservatore)	Allega un listener per gli eventi QuerySnapshot . Puoi passare singoli callback onNext e onError o passare un singolo oggetto osservatore con callback next ed error . Il listener può essere annullato chiamando la funzione restituita quando viene chiamato onSnapshot . NOTA: sebbene sia possibile fornire un callback onCompletion , non verrà mai chiamato perché il flusso di snapshot non termina mai.
onSnapshot(query, opzioni, osservatore)	Allega un listener per gli eventi QuerySnapshot . Puoi passare singoli callback onNext e onError o passare un singolo oggetto osservatore con callback next ed error . Il listener può essere annullato chiamando la funzione restituita quando viene chiamato onSnapshot . NOTA: sebbene sia possibile fornire un callback onCompletion , non verrà mai chiamato perché il flusso di snapshot non termina mai.
onSnapshot(query, onNext, onError, onCompletion)	Allega un listener per gli eventi QuerySnapshot . Puoi passare singoli callback onNext e onError o passare un singolo oggetto osservatore con callback next ed error . Il listener può essere annullato chiamando la funzione restituita quando viene chiamato onSnapshot . NOTA: sebbene sia possibile fornire un callback onCompletion , non verrà mai chiamato perché il flusso di snapshot non termina mai.
onSnapshot(query, opzioni, onNext, onError, onCompletion)	Allega un listener per gli eventi QuerySnapshot . Puoi passare singoli callback onNext e onError o passare un singolo oggetto osservatore con callback next ed error . Il listener può essere annullato chiamando la funzione restituita quando viene chiamato onSnapshot . NOTA: sebbene sia possibile fornire un callback onCompletion , non verrà mai chiamato perché il flusso di snapshot non termina mai.
query(query, compositeFilter, queryConstraints)	Crea una nuova istanza immutabile di Query che viene estesa per includere anche vincoli di query aggiuntivi.
query(query, queryVincoli)	Crea una nuova istanza immutabile di Query che viene estesa per includere anche vincoli di query aggiuntivi.
funzione(queryVincoli, ...)
e(queryVincoli)	Crea un nuovo QueryCompositeFilterConstraint che è una congiunzione dei vincoli di filtro specificati. Un filtro di congiunzione include un documento se soddisfa tutti i filtri specificati.
o(queryConstraints)	Crea un nuovo QueryCompositeFilterConstraint che è una disgiunzione dei vincoli di filtro specificati. Un filtro di disgiunzione include un documento se soddisfa uno qualsiasi dei filtri indicati.
funzione(riferimento, ...)
addDoc(riferimento, dati)	Aggiungi un nuovo documento alla CollectionReference specificata con i dati forniti, assegnandogli automaticamente un ID documento.
collezione(riferimento, percorso, pathSegments)	Ottiene un'istanza CollectionReference che fa riferimento a una sottoraccolta di reference nel percorso relativo specificato.
collezione(riferimento, percorso, pathSegments)	Ottiene un'istanza CollectionReference che fa riferimento a una sottoraccolta di reference nel percorso relativo specificato.
deleteDoc(riferimento)	Elimina il documento a cui fa riferimento l' DocumentReference specificato.
doc(riferimento, percorso, segmenti percorso)	Ottiene un'istanza DocumentReference che fa riferimento a un documento all'interno del reference nel percorso relativo specificato. Se non viene specificato alcun percorso, verrà utilizzato un ID univoco generato automaticamente per il DocumentReference restituito.
doc(riferimento, percorso, segmenti percorso)	Ottiene un'istanza DocumentReference che fa riferimento a un documento all'interno del reference nel percorso relativo specificato.
getDoc(riferimento)	Legge il documento a cui fa riferimento questo DocumentReference . Nota: getDoc() tenta di fornire dati aggiornati quando possibile attendendo i dati dal server, ma potrebbe restituire dati memorizzati nella cache o fallire se sei offline e il server non può essere raggiunto. Per specificare questo comportamento, richiama getDocFromCache() o getDocFromServer() .
getDocFromCache(riferimento)	Legge il documento a cui fa riferimento questo DocumentReference dalla cache. Restituisce un errore se il documento non è attualmente memorizzato nella cache.
getDocFromServer(riferimento)	Legge il documento a cui fa riferimento questo DocumentReference dal server. Restituisce un errore se la rete non è disponibile.
onSnapshot(riferimento, osservatore)	Allega un ascoltatore per gli eventi DocumentSnapshot . Puoi passare singoli callback onNext e onError o passare un singolo oggetto osservatore con callback next ed error . NOTA: sebbene sia possibile fornire un callback onCompletion , non verrà mai chiamato perché il flusso di snapshot non termina mai.
onSnapshot(riferimento, opzioni, osservatore)	Allega un ascoltatore per gli eventi DocumentSnapshot . Puoi passare singoli callback onNext e onError o passare un singolo oggetto osservatore con callback next ed error . NOTA: sebbene sia possibile fornire un callback onCompletion , non verrà mai chiamato perché il flusso di snapshot non termina mai.
onSnapshot(riferimento, onNext, onError, onCompletion)	Allega un ascoltatore per gli eventi DocumentSnapshot . Puoi passare singoli callback onNext e onError o passare un singolo oggetto osservatore con callback next ed error . NOTA: sebbene sia possibile fornire un callback onCompletion , non verrà mai chiamato perché il flusso di snapshot non termina mai.
onSnapshot(riferimento, opzioni, onNext, onError, onCompletion)	Allega un ascoltatore per gli eventi DocumentSnapshot . Puoi passare singoli callback onNext e onError o passare un singolo oggetto osservatore con callback next ed error . NOTA: sebbene sia possibile fornire un callback onCompletion , non verrà mai chiamato perché il flusso di snapshot non termina mai.
setDoc(riferimento, dati)	Scrive al documento a cui fa riferimento questo DocumentReference . Se il documento non esiste ancora, verrà creato.
setDoc(riferimento, dati, opzioni)	Scrive nel documento a cui fa riferimento l' DocumentReference specificato. Se il documento non esiste ancora, verrà creato. Se fornisci merge o mergeFields , i dati forniti possono essere uniti in un documento esistente.
updateDoc(riferimento, dati)	Aggiorna i campi nel documento a cui fa riferimento l' DocumentReference specificato. L'aggiornamento fallirà se applicato a un documento che non esiste.
updateDoc(riferimento, campo, valore, moreFieldsAndValues)	Aggiorna i campi nel documento a cui fa riferimento il DocumentReference specificato. L'aggiornamento fallirà se applicato a un documento che non esiste. I campi nidificati possono essere aggiornati fornendo stringhe di percorsi di campo separati da punti o fornendo oggetti FieldPath .
funzione(impostazioni, ...)
memoriaLocalCache(impostazioni)	Crea un'istanza di MemoryLocalCache . L'istanza può essere impostata su FirestoreSettings.cache per indicare all'SDK quale livello di cache utilizzare.
memoryLruGarbageCollector(impostazioni)	Crea un'istanza di MemoryLruGarbageCollector . È possibile specificare una dimensione target come parte del parametro di impostazione. Il raccoglitore inizierà a eliminare i documenti una volta che la dimensione della cache supera la dimensione specificata. La dimensione predefinita della cache è 40 MB (40 * 1024 * 1024 byte).
persistentLocalCache(impostazioni)	Crea un'istanza di PersistentLocalCache . L'istanza può essere impostata su FirestoreSettings.cache per indicare all'SDK quale livello di cache utilizzare. La cache persistente non può essere utilizzata in un ambiente Node.js.
persistentSingleTabManager(impostazioni)	Crea un'istanza di PersistentSingleTabManager .
funzione(istantanea, ...)
endAt(istantanea)	Crea un oggetto QueryEndAtConstraint che modifica il set di risultati in modo che termini con il documento fornito (incluso). La posizione finale è relativa all'ordine della query. Il documento deve contenere tutti i campi forniti nell'ordine orderBy della query.
finePrima(istantanea)	Crea un oggetto QueryEndAtConstraint che modifica il set di risultati in modo che termini prima del documento fornito (esclusivo). La posizione finale è relativa all'ordine della query. Il documento deve contenere tutti i campi forniti nell'ordine orderBy della query.
startAfter(istantanea)	Crea un oggetto QueryStartAtConstraint che modifica il set di risultati in modo che inizi dopo il documento fornito (esclusivo). La posizione iniziale è relativa all'ordine della query. Il documento deve contenere tutti i campi forniti nell'ordine orderBy della query.
startAt(istantanea)	Crea un oggetto QueryStartAtConstraint che modifica il set di risultati in modo che inizi dal documento fornito (incluso). La posizione iniziale è relativa all'ordine della query. Il documento deve contenere tutti i campi forniti nell'ordine orderBy di questa query.

Classi

Classe	Descrizione
Campo aggregato	Rappresenta un'aggregazione che può essere eseguita da Firestore.
AggregateQuerySnapshot	I risultati dell'esecuzione di una query di aggregazione.
Byte	Un oggetto immutabile che rappresenta una matrice di byte.
CollezioneRiferimento	Un oggetto CollectionReference può essere utilizzato per aggiungere documenti, ottenere riferimenti a documenti ed eseguire query su documenti (utilizzando query() ).
Riferimento documento	Un DocumentReference fa riferimento alla posizione di un documento in un database Firestore e può essere utilizzato per scrivere, leggere o ascoltare la posizione. Il documento nella posizione di riferimento può esistere o meno.
Istantanea del documento	Un DocumentSnapshot contiene i dati letti da un documento nel database Firestore. I dati possono essere estratti con .data() o .get(<field>) per ottenere un campo specifico. Per un DocumentSnapshot che punta a un documento inesistente, qualsiasi accesso ai dati restituirà "undefinito". Puoi utilizzare il metodo exists() per verificare esplicitamente l'esistenza di un documento.
CampoPercorso	Un FieldPath fa riferimento a un campo in un documento. Il percorso può essere costituito da un singolo nome di campo (che fa riferimento a un campo di livello superiore nel documento) o da un elenco di nomi di campo (che fa riferimento a un campo nidificato nel documento). Crea un FieldPath fornendo i nomi dei campi. Se viene fornito più di un nome di campo, il percorso punterà a un campo nidificato in un documento.
CampoValore	Valori sentinella che possono essere utilizzati durante la scrittura dei campi del documento con set() o update() .
Firestore	L'interfaccia del servizio Cloud Firestore. Non chiamare direttamente questo costruttore. Utilizza invece getFirestore() .
FirestoreErrore	Un errore restituito da un'operazione Firestore.
GeoPoint	Un oggetto immutabile che rappresenta una posizione geografica in Firestore. La posizione è rappresentata come coppia latitudine/longitudine. I valori di latitudine sono compresi nell'intervallo [-90, 90]. I valori di longitudine sono compresi nell'intervallo [-180, 180].
CaricaBundleTask	Rappresenta l'attività di caricamento di un bundle Firestore. Fornisce l'avanzamento del caricamento del bundle, nonché il completamento delle attività e gli eventi di errore. L'API è compatibile con Promise<LoadBundleTaskProgress> .
PersistentCacheIndexManager	Un PersistentCacheIndexManager per la configurazione degli indici della cache persistente utilizzati per l'esecuzione di query locali. Per utilizzarlo, chiama getPersistentCacheIndexManager() per ottenere un'istanza.
Domanda	Una Query si riferisce a una query che puoi leggere o ascoltare. Puoi anche costruire oggetti Query perfezionati aggiungendo filtri e ordinandoli.
QueryCompositeFilterVincolo	Un QueryCompositeFilterConstraint viene utilizzato per restringere il set di documenti restituiti da una query Firestore eseguendo l'OR o l'AND logico di più QueryFieldFilterConstraint s o QueryCompositeFilterConstraint S. QueryCompositeFilterConstraint vengono creati richiamando or() o and() e possono quindi essere passati a query() per creare una nuova istanza di query che contiene anche QueryCompositeFilterConstraint .
Vincolo di query	Un QueryConstraint viene utilizzato per restringere l'insieme di documenti restituiti da una query Firestore. I QueryConstraint vengono creati invocando where() , ordinato da() , iniziare a() , startAfter() , finePrima() , fineAt() , limite() , limitToLast() e può quindi essere passato a query() per creare una nuova istanza di query che contenga anche questo QueryConstraint .
QueryDocumentSnapshot	Un QueryDocumentSnapshot contiene dati letti da un documento nel database Firestore come parte di una query. L'esistenza del documento è garantita e i suoi dati possono essere estratti con .data() o .get(<field>) per ottenere un campo specifico. Un QueryDocumentSnapshot offre la stessa superficie API di un DocumentSnapshot . Poiché i risultati della query contengono solo documenti esistenti, la proprietà exists sarà sempre vera e data() non restituirà mai 'undefinito'.
QueryEndAtConstraint	Un QueryEndAtConstraint viene utilizzato per escludere i documenti dalla fine di un set di risultati restituito da una query Firestore. QueryEndAtConstraint vengono creati richiamando endAt() o endBefore() e possono quindi essere passati a query() per creare una nuova istanza di query che contiene anche questo QueryEndAtConstraint .
VincoloFiltroCampoQuery	Un QueryFieldFilterConstraint viene utilizzato per restringere il set di documenti restituiti da una query Firestore filtrando uno o più campi del documento. QueryFieldFilterConstraint vengono creati richiamando where() e possono quindi essere passati a query() per creare una nuova istanza di query che contiene anche questo QueryFieldFilterConstraint .
VincoloLimiteQuery	Un QueryLimitConstraint viene utilizzato per limitare il numero di documenti restituiti da una query Firestore. QueryLimitConstraint vengono creati richiamando limit() o limitToLast() e possono quindi essere passati a query() per creare una nuova istanza di query che contiene anche questo QueryLimitConstraint .
QueryOrderByConstraint	Un QueryOrderByConstraint viene utilizzato per ordinare il set di documenti restituiti da una query Firestore. QueryOrderByConstraint S viene creato invocando orderby () e possono quindi essere passati a query () per creare una nuova istanza di query che contiene anche questa QueryOrderByConstraint . Nota: i documenti che non contengono il campo Ordine non saranno presenti nel risultato della query.
Querysnapshot	Una QuerySnapshot contiene zero o più oggetti DocumentSnapshot che rappresentano i risultati di una query. È possibile accedere ai documenti come array tramite la proprietà docs o enumerati usando il metodo forEach . Il numero di documenti può essere determinato tramite le proprietà empty e size .
QuerystartatConstraint	Una QueryStartAtConstraint viene utilizzata per escludere i documenti dall'inizio di un set di risultati restituito da una query FireStore. QueryStartAtConstraint S sono creati invocando StartAT () o StartaFter () e possono quindi essere passati a Query () per creare una nuova istanza di query che contenga anche questa QueryStartAtConstraint .
Snapshotmetadata	Metadati su un'istantanea, descrivendo lo stato dell'istantanea.
Timestamp	Un Timestamp rappresenta un punto nel tempo indipendente da qualsiasi fuso orario o calendario, rappresentato come secondi e frazioni di secondi alla risoluzione di nanosecondi nell'epoca UTC. È codificato usando il calendario gregoriano prolettico che estende il calendario gregoriano all'indietro all'anno uno. È codificato supponendo che tutti i minuti siano lunghi 60 secondi, cioè i secondi di salto sono "imbrattati" in modo che non sia necessaria alcuna tabella di salto per l'interpretazione. L'intervallo va da 0001-01-01T00: 00: 00Z a 9999-12-31T23: 59: 59.99999999z. Per esempi e ulteriori specifiche, fare riferimento alla definizione del timestamp .
Transazione	Un riferimento a una transazione. L'oggetto Transaction passata alla updateFunction di una transazione fornisce i metodi per leggere e scrivere i dati nel contesto della transazione. Vedi runTransaction () .
WriteBatch	Un lotto di scrittura, usato per eseguire più scritture come una singola unità atomica. Un oggetto WriteBatch può essere acquisito chiamando WriteBatch () . Fornisce metodi per l'aggiunta di scritture al lotto di scrittura. Nessuna delle scritture verrà commessa (o visibile localmente) fino a quando non viene chiamato WriteBatch.commit () .

Interfacce

Interfaccia	Descrizione
AggregatesPec	Specifica una serie di aggregazioni e i loro alias.
DocumentChange	Uno DocumentChange rappresenta una modifica ai documenti che corrispondono a una query. Contiene il documento interessato e il tipo di modifica verificatisi.
DocumentData	Documenta i dati (per l'uso con setDoc () ) è costituito da campi mappati su valori.
Sperimentallongpollingoptions	Opzioni che configurano il trasporto di rete sottostante (WebChannel) dell'SDK quando viene utilizzato il polling lungo. Nota: questa interfaccia è "sperimentale" ed è soggetta a modifiche. Vedi FirestoreSettings.experimentalAutoDetectLongPolling , FirestoreSettings.experimentalForceLongPolling . ExperimentalForcelongPolling e FirestoreSettings.experimentalLongPollingOptions .
FireStoredataConverter	Convertitore utilizzato da withConverter() per trasformare gli oggetti utente di tipo AppModelType in dati FireStore di tipo DbModelType . L'uso del convertitore consente di specificare argomenti di tipo generico durante la memorizzazione e il recupero di oggetti da FireStore. In questo contesto, un "AppModel" è una classe utilizzata in un'applicazione per impacchettare insieme informazioni e funzionalità correlate. Tale classe potrebbe, ad esempio, avere proprietà con tipi di dati nidificati complessi, proprietà utilizzate per la memorizzazione, proprietà di tipi non supportati da FireStore (come symbol e bigint ) e funzioni di helper che eseguono operazioni composte. Tali classi non sono adatte e/o possibili per archiviare in un database FireStore. Invece, istanze di tali classi devono essere convertiti in "semplici oggetti Javascript" (Pojos) con proprietà esclusivamente primitive, potenzialmente nidificate all'interno di altri pojos o array di pojos. In questo contesto, questo tipo viene definito "dbmodel" e sarebbe un oggetto adatto per persistere nel Firestore. Per comodità, le applicazioni possono implementare FirestoreDataConverter e registrare il convertitore con oggetti FireStore, come DocumentReference o Query , per convertire automaticamente AppModel in DbModel quando si archiviano in FireStore e convertire DbModel in AppModel quando si recano da FireStore.
Firestorestings	Specifica le configurazioni personalizzate per l'istanza di Cloud FireStore. È necessario impostarli prima di invocare qualsiasi altro metodo.
Indice	(Beta) La definizione SDK di un indice Firestore.
IndiceConfigurazione	(Beta) Un elenco di indici di Firestore per accelerare l'esecuzione della query locale. Vedere il formato JSON per una descrizione del formato della definizione dell'indice.
Campo indice	(Beta) Un singolo elemento di campo in una configurazione dell'indice.
LoadBundleAskProgress	Rappresenta un aggiornamento di avanzamento o uno stato finale dal caricamento di fasci.
Memorycachesettings	Un oggetto di impostazioni per configurare un'istanza MemoryLocalCache .
MemoryagergarbageCollector	Un collezionista di immondizia elimina i documenti ogni volta che non fanno parte di domande attive e non hanno mutazioni locali ad esse collegate. Questo collezionista cerca di garantire le impronte di memoria più basse dall'SDK, a rischio che i documenti non vengano memorizzati nella cache per le domande offline o per le domande dirette alla cache. Usa la funzione di fabbrica per creare un'istanza di questo collezionista.
MemoryLocalcache	Fornisce una cache in memoria all'SDK. Questa è la cache predefinita se non diversamente configurata. Per utilizzare, creare un'istanza utilizzando la funzione Factory, quindi impostare l'istanza su FirestoreSettings.cache e chiamare initializeFirestore utilizzando l'oggetto Impostazioni.
MemorylrugarbageCollector	Un collettore di immondizia elimina i documenti meno usati in più in lotti. Questo collettore è configurato con una dimensione target e eseguirà la raccolta solo quando i documenti memorizzati nella cache superano la dimensione del bersaglio. Evita di interrogare il backend ripetuto per la stessa domanda o documento, a rischio di avere un'impronta di memoria più grande. Usa la funzione di fabbrica per creare un'istanza di questo collezionista.
Persistenza	Impostazioni che possono essere passate per enableIndexedDbPersistence() di configurare la persistenza del Firestore. La persistenza non può essere utilizzata in un ambiente nodo.js.
PersistentCacheSettings	Un'impostazione si oppone a configurare un'istanza PersistentLocalCache . La cache persistente non può essere utilizzata in un ambiente nodo.js.
Persistentlocalcache	Fornisce una cache persistente sostenuta da IndexedDB all'SDK. Per utilizzare, creare un'istanza utilizzando la funzione Factory, quindi impostare l'istanza su FirestoreSettings.cache e chiamare initializeFirestore utilizzando l'oggetto Impostazioni.
PersistentMultipletabManager	Un gestore scheda supporta più schede. SDK sincronizzerà query e mutazioni eseguite in tutte le schede usando l'SDK.
Persistente in manager	Un gestore di schede che supporta solo una scheda, nessuna sincronizzazione verrà eseguita tra le schede.
Persistenti che si muovono	Digitare per configurare un'istanza PersistentSingleTabManager .
Snapshotlistenoptions	Un oggetto Opzioni che può essere passato a OnSnapShot () e querysnapShot.docchange () per controllare quali tipi di modifiche includono nel set di risultati.
Snapshotoptions	Opzioni che configurano il modo in cui i dati vengono recuperati da un DocumentSnapshot (ad esempio il comportamento desiderato per i timestamp del server che non sono stati ancora impostati sul loro valore finale).
Transazioni	Opzioni per personalizzare il comportamento delle transazioni.
Annulla l'iscrizione	Una funzione restituita da onSnapshot() che rimuove l'ascoltatore quando viene invocata.

Variabili

Variabile	Descrizione
Cache_size_unlimited	La costante utilizzata per indicare che la collezione Garbage LRU dovrebbe essere disabilitata. Imposta questo valore come cacheSizeBytes sulle impostazioni passate all'istanza del Firestore .

Digitare gli alias

Digita alias	Descrizione
ADDPREFIXTOKEYS	Restituisce una nuova mappa in cui ogni chiave è prefissata con la chiave esterna aggiunta a un punto.
AggregateFieldType	L'Unione di tutti i tipi AggregateField supportati da FireStore.
Aggregatespecdata	Un tipo le cui chiavi sono prelevate da un AggregateSpec e i cui valori sono il risultato dell'aggregazione eseguita dal corrispondente AggregateField da AggregateSpec di input.
AggregateType	Tipo di unione che rappresenta il tipo aggregato da eseguire.
ChildUpdatefields	Aiutante per il calcolo dei campi nidificati per un determinato tipo T1. Questo è necessario per distribuire tipi sindacali come undefined | {...} (accade per oggetti di scena opzionali) o {a: A} | {b: B} . In questo caso d'uso, V viene utilizzato per distribuire i tipi dell'Unione di T[K] Record , poiché T[K] viene valutato come espressione e non distribuito. Vedi https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types
DocumentChangeType	Il tipo di uno DocumentChange può essere "aggiunto", "rimosso" o "modificato".
FireStoreRrorCode	L'insieme dei codici di stato del fuoco. I codici sono gli stessi in quelli esposti da GRPC qui: https://github.com/grpc/grpc/blob/master/doc/statusSodes.md Valori possibili: - "Annullati": l'operazione è stata annullata (in genere dal chiamante). - "Sconosciuto": errore sconosciuto o un errore da un diverso dominio di errore. - "Invalid-Argument": il cliente ha specificato un argomento non valido. Si noti che ciò differisce da "non riuscita". "Invalid-Argument" indica argomenti problematici indipendentemente dallo stato del sistema (ad es. Un nome di campo non valido). - "Deadline-Exceded": scadenza scaduta prima che l'operazione potesse completare. Per le operazioni che cambiano lo stato del sistema, questo errore può essere restituito anche se l'operazione è completata correttamente. Ad esempio, una risposta riuscita da un server avrebbe potuto essere ritardata abbastanza a lungo da consentire alla scadenza della scadenza. - 'No-FOUND': non è stato trovato alcuni documenti richiesti. - "Già esiste": alcuni documenti che abbiamo tentato di creare già esistono. - 'Denied autorizzazione': il chiamante non ha il permesso di eseguire l'operazione specificata. -"Esplorato le risorse": alcune risorse sono state esaurite, forse una quota per utente, o forse l'intero file system è fuori spazio. - "Precondizioni non riuscite": l'operazione è stata respinta perché il sistema non è in uno stato richiesto per l'esecuzione dell'operazione. - "Aborted": l'operazione è stata interrotta, in genere a causa di un problema di concorrenza come le transazioni aborte, ecc.- "Out-of-range": l'operazione è stata tentata oltre l'intervallo valido. - "Unimplement": l'operazione non è implementata o non supportata/abilitata. - 'Internal': errori interni. Significa che alcuni invarianti previsti dal sistema sottostante sono stati rotti. Se vedi uno di questi errori, qualcosa è molto rotto. - "non disponibile": il servizio non è attualmente disponibile. Questa è molto probabilmente una condizione transitoria e può essere corretta riprovando con un backoff. - "Perdita di dati": perdita o corruzione dei dati irrecuperabili. - "non autenticato": la richiesta non ha credenziali di autenticazione valide per l'operazione.
FireStorelocalcache	Tipo di unione da tutti i livelli di cache SDK supportati.
Elensource	Descrivi la fonte a una query ascolta. Imposta su default per ascoltare sia le modifiche alla cache che del server. Impostare su cache per ascoltare le modifiche solo nella cache.
MemoryGarbageCollector	Tipo di unione da tutti i collezionisti di Gabage per la cache locale di memoria.
Nidificatifield	Per ogni campo (ad esempio 'bar'), trova tutte le chiavi nidificate (ad esempio { 'bar.baz': t1, 'bar.qux': t2 } ). Intersecali insieme per creare una singola mappa contenente tutte le chiavi possibili che sono tutte contrassegnate come opzionali
Orderbydirection	La direzione di una clausola OrderBy () è specificata come "DESC" o "ASC" (discendente o ascendente).
ParzialewithfieldValue	Simile al Partial<T> di TypeScript, ma consente di omettere i campi nidificati e i valori di campo di essere passati come valori di proprietà.
PersistentTabManager	Un'unione di tutti i gestori di schede disponibili.
Primitivo	Tipi primitivi.
QueryConstraintType	Descrive i diversi vincoli di query disponibili in questo SDK.
Queryfilterconstraint	QueryFilterConstraint è un tipo di unione Helper che rappresenta QueryFieldFilterConstraint e QueryCompositeFilterConstraint .
QuerynonfilterConstraint	QueryNonFilterConstraint è un tipo di unione di Helper che rappresenta i querycostraints che vengono utilizzati per restringere o ordinare l'insieme di documenti, ma che non filtrano esplicitamente su un campo del documento. QueryNonFilterConstraint s sono creati invocando orderby () , iniziare a() , startafter () , endBefore () , endat () , limite () o limittolast () e possono quindi essere passati a query () per creare una nuova istanza di query che contiene anche la QueryConstraint .
Setoptions	Un oggetto Opzioni che configura il comportamento di setDoc () e chiama. Queste chiamate possono essere configurate per eseguire le fusioni granulari invece di sovrascrivere i documenti target nella loro interezza fornendo un Misction SetOptions merge: true .
Taskstate	Rappresenta lo stato delle attività di caricamento del pacchetto. Sia "errore" che "successo" stanno affondando lo stato: l'attività interromperà o completerà e non ci saranno più aggiornamenti dopo che sono stati riportati.
Union ToIndtersencection	Dato un tipo di unione U = T1 | T2 | ... , restituisce un tipo intersecato (T1 & T2 & ...) . Utilizza tipi condizionali distributivi e inferenza dai tipi condizionali. Funziona perché più candidati per lo stesso tipo variabile in posizioni contro-varianti provoca l'inferimento di un tipo di intersezione. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection -tipo
Aggiornato	Aggiorna i dati (per l'uso con updatedoc () ) che consiste in percorsi sul campo (ad esempio "foo" o "foo.baz") mappati ai valori. Campi che contengono i campi nidificati di riferimento di punti all'interno del documento. I valori di campo possono essere passati come valori di proprietà.
Wherefilterop	Le condizioni di filtro in una clausola dove () sono specificate usando le stringhe '& lt;', '& lt; =', '==', '! =', '& Gt; =', '& gt;', 'Array-Contains' , "in", "contad-contains-any" e "not-in".
ConfieldValue	Consente di passare i valori di campo come valore della proprietà mantenendo la sicurezza del tipo.

funzione (app, ...)

GetFirestore (app)

Restituisce l'istanza di FireStore predefinita esistente associata al FireBasepp fornito . Se non esiste un'istanza, inizializza una nuova istanza con impostazioni predefinite.

Firma:

export declare function getFirestore(app: FirebaseApp): Firestore;

Parametri

Parametro	Tipo	Descrizione
app	FireBasepp	L'istanza di Firebasepp a cui è associata l'istanza del fuoco restituito.

Ritorna:

Firestore

L'istanza di Firestore predefinita dell'app fornita.

getFireStore (app, databaseId)

Questa API è fornita come anteprima per gli sviluppatori e può cambiare in base al feedback che riceviamo. Non utilizzare questa API in un ambiente di produzione.

Restituisce l'istanza di Firestore nominata esistente associata al FireBasepp fornito . Se non esiste un'istanza, inizializza una nuova istanza con impostazioni predefinite.

Firma:

export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;

Parametri

Parametro	Tipo	Descrizione
app	FireBasepp	L'istanza di Firebasepp a cui è associata l'istanza del fuoco restituito.
DatabaseId	corda	Il nome del database.

Ritorna:

Firestore

L'istanza di Firestore nominata dell'app fornita.

InitializeFireStore (app, Impostazioni, DatabaseID)

Inizializza una nuova istanza di FireStore con le impostazioni fornite. Può essere chiamato solo prima di qualsiasi altra funzione, incluso GetFireStore () . Se le impostazioni personalizzate sono vuote, questa funzione è equivalente a chiamare getFireStore () .

Firma:

export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;

Parametri

Parametro	Tipo	Descrizione
app	FireBasepp	Il Firebasepp con cui sarà associata l'istanza del fuoco .
impostazioni	Firestorestings	Un obiettivo di impostazioni per configurare l'istanza del FireStore .
DatabaseId	corda	Il nome del database.

Ritorna:

Firestore

Un'istanza di FireStore di nuova inizializzata.

funzione (Firestore, ...)

ClearIndexEddBPersistence (Firestore)

Cancella lo spazio di archiviazione persistente. Ciò include scritture in sospeso e documenti memorizzati nella cache.

Deve essere chiamato mentre l'istanza di FireStore non viene avviata (dopo che l'app è terminata o quando l'app viene inizializzata per la prima volta). All'avvio, questa funzione deve essere chiamata prima di altre funzioni (diverse da inizializeFirestore () o getFireStore () )). Se l'istanza di Firestore è ancora in esecuzione, la promessa verrà respinta con il codice di errore di failed-precondition .

NOTA: clearIndexedDbPersistence() è principalmente inteso ad aiutare a scrivere test affidabili che utilizzano Cloud Firestore. Utilizza un meccanismo efficiente per far cadere i dati esistenti ma non tenta di sovrascrivere in modo sicuro o rendere i dati memorizzati nella cache irrecuperabili. Per applicazioni sensibili alla divulgazione di dati memorizzati nella cache tra le sessioni dell'utente, si consiglia vivamente di non consentire affatto la persistenza.

Firma:

export declare function clearIndexedDbPersistence(firestore: Firestore): Promise<void>;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore	L'istanza del fuoco per chiarire la persistenza.

Ritorna:

Promise <void>

Una Promise che viene risolta quando lo stoccaggio persistente viene cancellato. Altrimenti, la promessa viene respinta con un errore.

Collezione (Firestore, Path, PathSegments)

Ottiene un'istanza CollectionReference che si riferisce alla raccolta nel percorso assoluto specificato.

Firma:

export declare function collection(firestore: Firestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore	Un riferimento all'istanza del Firestore radice.
sentiero	corda	Un percorso separato da una raccolta verso una raccolta.
percorsi	corda[]	Segmenti di percorso aggiuntivi da applicare rispetto al primo argomento.

Ritorna:

Raccoltareferenza < DocumentData , DocumentData >

L'istanza CollectionReference .

Eccezioni

Se il percorso finale ha un numero pari di segmenti e non indica una raccolta.

CollectionGroup (FireStore, CollectionId)

Crea e restituisce una nuova istanza Query che include tutti i documenti nel database contenuti in una raccolta o sottocollezione con la collectionId data .

Firma:

export declare function collectionGroup(firestore: Firestore, collectionId: string): Query<DocumentData, DocumentData>;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore	Un riferimento all'istanza del Firestore radice.
CollectionId	corda	Identifica le collezioni per interrogare. Verrà incluso ogni raccolta o subcollezione con questo ID come ultimo segmento del suo percorso. Non può contenere una barra.

Ritorna:

Domanda < DocumentData , DocumentData >

La Query creata .

ConnectFireStoreMulator (FireStore, Host, Port, Options)

Modifica questa istanza per comunicare con l'emulatore di Firestore Cloud.

Nota: questo deve essere chiamato prima che questa istanza venga utilizzata per eseguire qualsiasi operazione.

Firma:

export declare function connectFirestoreEmulator(firestore: Firestore, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore	L'istanza Firestore da configurare per connettersi all'emulatore.
ospite	corda	L'host emulatore (Ex: localhost).
porta	numero	La porta dell'emulatore (Ex: 9000).
opzioni	{MockUserToken?: EmulatormockTokenOptions | corda; }

Ritorna:

vuoto

DisableneTwork (FireStore)

Disabilita l'utilizzo della rete per questa istanza. Può essere riabilitato tramite abilitNetWork () . Mentre la rete è disabilitata, le chiamate di eventuali ascoltatori di snapshot, getDoc() o getDocs() restituiranno i risultati dalla cache e qualsiasi operazione di scrittura verrà messo in coda fino a quando la rete non sarà ripristinata.

Firma:

export declare function disableNetwork(firestore: Firestore): Promise<void>;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore

Ritorna:

Promise <void>

Una Promise che viene risolta una volta che la rete è stata disabilitata.

Doc (Firestore, Path, PathSegments)

Ottiene un'istanza DocumentReference che si riferisce al documento nel percorso assoluto specificato.

Firma:

export declare function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore	Un riferimento all'istanza del Firestore radice.
sentiero	corda	Un percorso separato da una taglio a un documento.
percorsi	corda[]	Segmenti di percorso aggiuntivi che verranno applicati rispetto al primo argomento.

Ritorna:

DocumentReference < DocumentData , DocumentData >

L'istanza DocumentReference .

Eccezioni

Se il percorso finale ha un numero dispari di segmenti e non indica un documento.

abilitineddbpersistence (FireStore, Persistencesettings)

ATTENZIONE: questa API è ora obsoleta.

Questa funzione verrà rimossa in una futura versione principale. Invece, impostare FirestoreSettings.localCache su un'istanza di PersistentLocalCache per attivare la cache IndexedDB. Chiamare questa funzione quando è già specificato FirestoreSettings.localCache lancerà un'eccezione.

Tenta di consentire l'archiviazione persistente, se possibile.

In caso di fallimento, enableIndexedDbPersistence() rifiuterà la promessa o lancerà un'eccezione. Ci sono diversi motivi per cui questo può fallire, che può essere identificato dal code sull'errore.

* Concludizione non riuscita: l'app è già aperta in un'altra scheda browser. * Non implementata: il browser è incompatibile con l'implementazione della persistenza offline.

Si noti che anche dopo un fallimento, l'istanza del fuoco rimarrà utilizzabile, tuttavia la persistenza offline sarà disabilitata.

NOTA: enableIndexedDbPersistence() deve essere chiamato prima di qualsiasi altra funzione (oltre a inizializeFireStore () , getFireStore () o clearIndexEddBPersistence () .

La persistenza non può essere utilizzata in un ambiente nodo.js.

Firma:

export declare function enableIndexedDbPersistence(firestore: Firestore, persistenceSettings?: PersistenceSettings): Promise<void>;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore	L'istanza del fuoco per consentire la persistenza per.
persistenza	Persistenza	Impostazioni opzionali Oggetto per configurare la persistenza.

Ritorna:

Promise <void>

Una Promise che rappresenta una memoria persistente abilitante con successo.

abilimultitabindexeddbpersistence (FireStore)

ATTENZIONE: questa API è ora obsoleta.

Questa funzione verrà rimossa in una futura versione principale. Invece, impostare FirestoreSettings.localCache su un'istanza di PersistentLocalCache per attivare la cache IndexedDB. Chiamare questa funzione quando è già specificato FirestoreSettings.localCache lancerà un'eccezione.

Tenta di consentire l'archiviazione persistente multi-tab, se possibile. Se abilitato in tutte le schede, tutte le operazioni condividono l'accesso alla persistenza locale, inclusa l'esecuzione condivisa di query e aggiornamenti di documenti locali compensati la latenza in tutte le istanze connesse.

In caso di fallimento, enableMultiTabIndexedDbPersistence() rifiuterà la promessa o lancerà un'eccezione. Ci sono diversi motivi per cui questo può fallire, che può essere identificato dal code sull'errore.

* Concondizione non riuscita: l'app è già aperta in un'altra scheda browser e Multi-TAB non è abilitata. * Non implementata: il browser è incompatibile con l'implementazione della persistenza offline.

Si noti che anche dopo un fallimento, l'istanza del fuoco rimarrà utilizzabile, tuttavia la persistenza offline sarà disabilitata.

Firma:

export declare function enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore	L'istanza del fuoco per consentire la persistenza per.

Ritorna:

Promise <void>

Una Promise che rappresenta una memoria persistente abilitante con successo.

EnableNetWork (FireStore)

Riabilita l'uso della rete per questa istanza di FireStore dopo una precedente chiamata a DisableNetWork () .

Firma:

export declare function enableNetwork(firestore: Firestore): Promise<void>;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore

Ritorna:

Promise <void>

Una Promise che viene risolta una volta che la rete è stata abilitata.

getPersistCacheIndexManager (Firestore)

Restituisce il gestore indice di PersistentCache utilizzato dall'oggetto Firestore dato.

L'istanza PersistentCacheIndexManager o null se l'archiviazione persistente locale non è in uso.

Firma:

export declare function getPersistentCacheIndexManager(firestore: Firestore): PersistentCacheIndexManager | null;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore

Ritorna:

PersistCacheIndexManager | nullo

LoadBundle (FireStore, BundleData)

Carica un pacchetto Firestore nella cache locale.

Firma:

export declare function loadBundle(firestore: Firestore, bundleData: ReadableStream<Uint8Array> | ArrayBuffer | string): LoadBundleTask;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore	L'istanza del fuoco per caricare bundle per.
Bundledata	ReableStream <Uint8array> | ArrayBuffer | corda	Un oggetto che rappresenta il pacchetto da caricare. Gli oggetti validi sono ArrayBuffer , ReadableStream<Uint8Array> o string .

Ritorna:

LoadBundleKask

Un oggetto LoadBundleTask , che notifica ai chiamanti aggiornamenti di avanzamento e eventi di completamento o errore. Può essere usato come Promise<LoadBundleTaskProgress> .

denominata (firestore, nome)

Legge una query FireStore dalla cache locale, identificata dal nome dato.

Le query denominate sono confezionate in bundle sul lato server (insieme a documenti risultanti) e caricate nella cache locale utilizzando loadBundle . Una volta nella cache locale, utilizzare questo metodo per estrarre una query per nome.

Firma:

export declare function namedQuery(firestore: Firestore, name: string): Promise<Query | null>;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore	L'istanza del fuoco da cui leggere la domanda.
nome	corda	Il nome della query.

Ritorna:

Promessa < query | null>

Una Promise che viene risolta con la query o null .

onsnapShotsinsync (Firestore, Observer)

Allega un ascoltatore per un evento snapshot-in-sync. L'evento snapshot-in-sync indica che tutti gli ascoltatori interessati da una determinata modifica sono stati licenziati, anche se un singolo cambiamento generato dal server influisce su più ascoltatori.

Nota: l'evento snapshot-in-sync indica solo che gli ascoltatori sono sincronizzati tra loro, ma non si riferiscono al fatto che tali snapshot siano sincronizzate con il server. Utilizzare SnapshotMetadata nei singoli ascoltatori per determinare se un'istantanea proviene dalla cache o dal server.

Firma:

export declare function onSnapshotsInSync(firestore: Firestore, observer: {
    next?: (value: void) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore	L'istanza di FireStore per la sincronizzazione delle istantanee.
osservatore	{Next?: (Value: void) => void; Errore?: (Errore: FireStoreRoror ) => void; completo?: () => void; }	Un singolo oggetto contenente callback next ed error .

Ritorna:

Annulla l'iscrizione

Una funzione di annullamento dell'iscrizione che può essere chiamata per annullare l'ascoltatore di snapshot.

onsnapShotsinsync (Firestore, OnSync)

Allega un ascoltatore per un evento snapshot-in-sync. L'evento snapshot-in-sync indica che tutti gli ascoltatori interessati da una determinata modifica sono stati licenziati, anche se un singolo cambiamento generato dal server influisce su più ascoltatori.

Nota: l'evento snapshot-in-sync indica solo che gli ascoltatori sono sincronizzati tra loro, ma non si riferiscono al fatto che tali snapshot siano sincronizzate con il server. Utilizzare SnapshotMetadata nei singoli ascoltatori per determinare se un'istantanea proviene dalla cache o dal server.

Firma:

export declare function onSnapshotsInSync(firestore: Firestore, onSync: () => void): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore	L'istanza Firestore per la sincronizzazione delle istantanee.
onsync	() => vuoto	Un callback da chiamare ogni volta che tutti gli ascoltatori di Snapshot sono sincronizzati tra loro.

Ritorna:

Annulla l'iscrizione

Una funzione di annullamento dell'iscrizione che può essere chiamata per annullare l'ascoltatore di snapshot.

RunTransaction (FireStore, UpdateFunction, Options)

Esegue la updateFunction fornita e quindi tenta di commettere le modifiche applicate all'interno della transazione. Se un documento letto nella transazione è cambiato, Cloud Firestore gira la updateFunction . Se non riesce a impegnarsi dopo 5 tentativi, la transazione fallisce.

Il numero massimo di scritture consentite in una singola transazione è 500.

Firma:

export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore	Un riferimento al database FireStore per eseguire questa transazione.
UpdateFunction	(Transazione: transazione ) => Promise <T>	La funzione da eseguire nel contesto della transazione.
opzioni	Transazioni	Un obiettivo di opzioni per configurare il numero massimo di tentativi di impegnarsi.

Ritorna:

Promise <T>

Se la transazione ha completato correttamente o è stata esplicitamente interrotta (la updateFunction ha restituito una promessa fallita), la promessa restituita dalla updateFunction viene restituito qui. Altrimenti, se la transazione non è riuscita, viene restituita una promessa rifiutata con l'errore di errore corrispondente.

SetIndexConfiguration (FireStore, Configuration)

Questa API è fornita come anteprima per gli sviluppatori e può cambiare in base al feedback che riceviamo. Non utilizzare questa API in un ambiente di produzione.

ATTENZIONE: questa API è ora obsoleta.

Invece di creare manualmente gli indici della cache, prendi in considerazione l'utilizzo di enablePersistentCacheIndexAutoCreation() per consentire all'SDK di decidere se creare indici di cache per le query in esecuzione a livello locale.

Configura l'indicizzazione per l'esecuzione della query locale. Qualsiasi configurazione dell'indice precedente è sovrascritta. La Promise si risolve una volta che la configurazione dell'indice è stata persistita.

Le stesse voci dell'indice sono create in modo asincrono. Puoi continuare a utilizzare query che richiedono l'indicizzazione anche se gli indici non sono ancora disponibili. L'esecuzione delle query inizierà automaticamente a utilizzare l'indice una volta che le voci dell'indice sono state scritte.

Gli indici sono supportati solo con la persistenza di IndexedDB. Se IndexedDB non è abilitato, qualsiasi configurazione dell'indice viene ignorata.

Firma:

export declare function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore	L'istanza Firestore per configurare gli indici per.
configurazione	IndiceConfigurazione	La definizione dell'indice.

Ritorna:

Promise <void>

Una Promise che si risolve una volta configurati tutti gli indici.

Eccezioni

FireStoreRoror se il formato JSON non è valido.

SetIndexConfiguration (FireStore, JSON)

Questa API è fornita come anteprima per gli sviluppatori e può cambiare in base al feedback che riceviamo. Non utilizzare questa API in un ambiente di produzione.

ATTENZIONE: questa API è ora obsoleta.

Invece di creare manualmente gli indici della cache, prendi in considerazione l'utilizzo di enablePersistentCacheIndexAutoCreation() per consentire all'SDK di decidere se creare indici di cache per le query in esecuzione a livello locale.

Configura l'indicizzazione per l'esecuzione della query locale. Qualsiasi configurazione dell'indice precedente è sovrascritta. La Promise si risolve una volta che la configurazione dell'indice è stata persistita.

Le stesse voci dell'indice sono create in modo asincrono. Puoi continuare a utilizzare query che richiedono l'indicizzazione anche se gli indici non sono ancora disponibili. L'esecuzione delle query inizierà automaticamente a utilizzare l'indice una volta che le voci dell'indice sono state scritte.

Gli indici sono supportati solo con la persistenza di IndexedDB. Invocare enableIndexedDbPersistence() o enableMultiTabIndexedDbPersistence() prima di impostare una configurazione dell'indice. Se IndexedDB non è abilitato, qualsiasi configurazione dell'indice viene ignorata.

Il metodo accetta il formato JSON esportato dalla CLI Firebase ( firebase firestore:indexes ). Se il formato JSON non è valido, questo metodo lancia un errore.

Firma:

export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore	L'istanza Firestore per configurare gli indici per.
json	corda	Il formato JSON esportato dalla CLI Firebase.

Ritorna:

Promise <void>

Una Promise che si risolve una volta configurati tutti gli indici.

Eccezioni

FireStoreRoror se il formato JSON non è valido.

Termina (Firestore)

Termina l'istanza di FireStore fornita.

Dopo aver chiamato terminate() è possibile utilizzare solo la funzione clearIndexedDbPersistence() . Qualsiasi altra funzione lancerà un FirestoreError .

Per riavviare dopo la risoluzione, creare una nuova istanza di FireBaseFirestore con GetFireStore () .

La terminazione non annulla alcuna scrittura in sospeso e qualsiasi promessa che in attesa di una risposta dal server non verrà risolta. Se hai abilitato la persistenza, la prossima volta che inizi questa istanza, riprenderà a inviare queste scritture al server.

Nota: in circostanze normali, non è richiesto la chiamata terminate() . Questa funzione è utile solo quando si desidera forzare questa istanza a rilasciare tutte le sue risorse o in combinazione con clearIndexedDbPersistence() per garantire che tutto lo stato locale venga distrutto tra le corse di prova.

Firma:

export declare function terminate(firestore: Firestore): Promise<void>;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore

Ritorna:

Promise <void>

Una Promise che viene risolta quando l'istanza è stata terminata con successo.

waitforependingwrites (FireStore)

Aspetta fino a quando tutte le scritture attualmente in sospeso per l'utente attivo sono state riconosciute dal backend.

La promessa restituita si risolve immediatamente se non ci sono scritture eccezionali. Altrimenti, la promessa attende tutte le scritture precedentemente emesse (comprese quelle scritte in una sessione di app precedente), ma non aspetta le scritture che sono state aggiunte dopo che la funzione è stata chiamata. Se vuoi aspettare ulteriori scritture, chiama di nuovo waitForPendingWrites() .

Eventuali promesse waitForPendingWrites() vengono respinte durante le modifiche dell'utente.

Firma:

export declare function waitForPendingWrites(firestore: Firestore): Promise<void>;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore

Ritorna:

Promise <void>

Una Promise che si risolve quando tutte le scritture attualmente in sospeso sono state riconosciute dal backend.

WriteBatch (FireStore)

Crea un batch di scrittura, usato per eseguire più scritture come singola operazione atomica. Il numero massimo di scritture consentite in un singolo WriteBatch è 500.

A differenza delle transazioni, i batch di scrittura sono persistiti offline e quindi sono preferibili quando non è necessario condizionare le tue scritture sui dati di lettura.

Firma:

export declare function writeBatch(firestore: Firestore): WriteBatch;

Parametri

Parametro	Tipo	Descrizione
fuoco	Firestore

Ritorna:

WriteBatch

Un WriteBatch che può essere utilizzato per eseguire atomicamente più scritture.

funzione()

contare()

Crea un oggetto AggregateField che può essere utilizzato per calcolare il conteggio dei documenti nell'insieme dei risultati di una query.

Firma:

export declare function count(): AggregateField<number>;

Ritorna:

Aggregatefield <Mumero>

deletefield ()

Restituisce un Sentinel per l'uso con updatedoc () o setDoc () con {merge: true} per contrassegnare un campo per la cancellazione.

Firma:

export declare function deleteField(): FieldValue;

Ritorna:

FieldValue

documentID ()

Restituisce uno speciale FieldPath Sentinel per fare riferimento all'ID di un documento. Può essere utilizzato nelle query per ordinare o filtrare dall'ID documento.

Firma:

export declare function documentId(): FieldPath;

Ritorna:

Campo di campo

getFireStore ()

Restituisce l'istanza di FireStore predefinita esistente associata al FireBasepp predefinito . Se non esiste un'istanza, inizializza una nuova istanza con impostazioni predefinite.

Firma:

export declare function getFirestore(): Firestore;

Ritorna:

Firestore

L'istanza di Firestore predefinita dell'app predefinita.

MemoryEagerGarbageCollector ()

Crea un'istanza di MemoryEagerGarbageCollector . Questo è anche il collettore di immondizia predefinito a meno che non sia esplicitamente specificato diversamente.

Firma:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

Ritorna:

MemoryagergarbageCollector

PersistentMultiPletaBManager ()

Crea un'istanza di PersistentMultipleTabManager .

Firma:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

Ritorna:

PersistentMultipletabManager

servertimestamp ()

Restituisce una sentinella utilizzata con setDoc () o updatedoc () per includere un timestamp generato dal server nei dati scritti.

Firma:

export declare function serverTimestamp(): FieldValue;

Ritorna:

FieldValue

funzione (databaseid, ...)

GetFireStore (DatabaseId)

Questa API è fornita come anteprima per gli sviluppatori e può cambiare in base al feedback che riceviamo. Non utilizzare questa API in un ambiente di produzione.

Restituisce l'istanza di FireStore nominata esistente associata al FireBasepp predefinito . Se non esiste un'istanza, inizializza una nuova istanza con impostazioni predefinite.

Firma:

export declare function getFirestore(databaseId: string): Firestore;

Parametri

Parametro	Tipo	Descrizione
DatabaseId	corda	Il nome del database.

Ritorna:

Firestore

L'istanza di Firestore nominata dell'app predefinita.

funzione (elementi, ...)

ArrayRemove (Elements)

Restituisce un valore speciale che può essere utilizzato con setDoc () o che indica al server di rimuovere gli elementi forniti da qualsiasi valore di array già esistente sul server. Tutte le istanze di ciascun elemento specificato verranno rimosse dall'array. If the field being modified is not already an array it will be overwritten with an empty array.

Firma:

export declare function arrayRemove(...elements: unknown[]): FieldValue;

Parametri

Parametro	Tipo	Descrizione
elementi	sconosciuto[]	The elements to remove from the array.

Ritorna:

FieldValue

The FieldValue sentinel for use in a call to setDoc() or updateDoc()

arrayUnion(elements)

Returns a special value that can be used with setDoc() or updateDoc() that tells the server to union the given elements with any array value that already exists on the server. Each specified element that doesn't already exist in the array will be added to the end. If the field being modified is not already an array it will be overwritten with an array containing exactly the specified elements.

Firma:

export declare function arrayUnion(...elements: unknown[]): FieldValue;

Parametri

Parametro	Tipo	Descrizione
elementi	sconosciuto[]	The elements to union into the array.

Ritorna:

FieldValue

The FieldValue sentinel for use in a call to setDoc() or updateDoc() .

function(field, ...)

average(field)

Create an AggregateField object that can be used to compute the average of a specified field over a range of documents in the result set of a query.

Firma:

export declare function average(field: string | FieldPath): AggregateField<number | null>;

Parametri

Parametro	Tipo	Descrizione
campo	string | FieldPath	Specifies the field to average across the result set.

Ritorna:

AggregateField <number | null>

sum(field)

Create an AggregateField object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.

Firma:

export declare function sum(field: string | FieldPath): AggregateField<number>;

Parametri

Parametro	Tipo	Descrizione
campo	string | FieldPath	Specifies the field to sum across the result set.

Ritorna:

AggregateField <number>

function(fieldPath, ...)

orderBy(fieldPath, directionStr)

Creates a QueryOrderByConstraint that sorts the query result by the specified field, optionally in descending order instead of ascending.

Note: Documents that do not contain the specified field will not be present in the query result.

Firma:

export declare function orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): QueryOrderByConstraint;

Parametri

Parametro	Tipo	Descrizione
fieldPath	string | FieldPath	The field to sort by.
directionStr	OrderByDirection	Optional direction to sort by ('asc' or 'desc'). If not specified, order will be ascending.

Ritorna:

QueryOrderByConstraint

The created QueryOrderByConstraint .

where(fieldPath, opStr, value)

Creates a QueryFieldFilterConstraint that enforces that documents must contain the specified field and that the value should satisfy the relation constraint provided.

Firma:

export declare function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryFieldFilterConstraint;

Parametri

Parametro	Tipo	Descrizione
fieldPath	string | FieldPath	The path to compare
opStr	WhereFilterOp	The operation string (eg "<", "<=", "==", "<", "<=", "!=").
valore	sconosciuto	The value for comparison

Ritorna:

QueryFieldFilterConstraint

The created QueryFieldFilterConstraint .

function(fieldValues, ...)

endAt(fieldValues)

Creates a QueryEndAtConstraint that modifies the result set to end at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

Firma:

export declare function endAt(...fieldValues: unknown[]): QueryEndAtConstraint;

Parametri

Parametro	Tipo	Descrizione
fieldValues	sconosciuto[]	The field values to end this query at, in order of the query's order by.

Ritorna:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(fieldValues)

Creates a QueryEndAtConstraint that modifies the result set to end before the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

Firma:

export declare function endBefore(...fieldValues: unknown[]): QueryEndAtConstraint;

Parametri

Parametro	Tipo	Descrizione
fieldValues	sconosciuto[]	The field values to end this query before, in order of the query's order by.

Ritorna:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(fieldValues)

Creates a QueryStartAtConstraint that modifies the result set to start after the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

Firma:

export declare function startAfter(...fieldValues: unknown[]): QueryStartAtConstraint;

Parametri

Parametro	Tipo	Descrizione
fieldValues	sconosciuto[]	The field values to start this query after, in order of the query's order by.

Ritorna:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(fieldValues)

Creates a QueryStartAtConstraint that modifies the result set to start at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

Firma:

export declare function startAt(...fieldValues: unknown[]): QueryStartAtConstraint;

Parametri

Parametro	Tipo	Descrizione
fieldValues	sconosciuto[]	The field values to start this query at, in order of the query's order by.

Ritorna:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

function(indexManager, ...)

deleteAllPersistentCacheIndexes(indexManager)

Removes all persistent cache indexes.

Please note this function will also deletes indexes generated by setIndexConfiguration() , which is deprecated.

Firma:

export declare function deleteAllPersistentCacheIndexes(indexManager: PersistentCacheIndexManager): void;

Parametri

Parametro	Tipo	Descrizione
indexManager	PersistentCacheIndexManager

Ritorna:

vuoto

disablePersistentCacheIndexAutoCreation(indexManager)

Stops creating persistent cache indexes automatically for local query execution. The indexes which have been created by calling enablePersistentCacheIndexAutoCreation() still take effect.

Firma:

export declare function disablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

Parametri

Parametro	Tipo	Descrizione
indexManager	PersistentCacheIndexManager

Ritorna:

vuoto

enablePersistentCacheIndexAutoCreation(indexManager)

Enables the SDK to create persistent cache indexes automatically for local query execution when the SDK believes cache indexes can help improve performance.

This feature is disabled by default.

Firma:

export declare function enablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

Parametri

Parametro	Tipo	Descrizione
indexManager	PersistentCacheIndexManager

Ritorna:

vuoto

function(left, ...)

aggregateFieldEqual(left, right)

Compares two 'AggregateField ` instances for equality.

Firma:

export declare function aggregateFieldEqual(left: AggregateField<unknown>, right: AggregateField<unknown>): boolean;

Parametri

Parametro	Tipo	Descrizione
Sinistra	AggregateField <unknown>	Compare this AggregateField to the right .
Giusto	AggregateField <unknown>	Compare this AggregateField to the left .

Ritorna:

boolean

aggregateQuerySnapshotEqual(left, right)

Compares two AggregateQuerySnapshot instances for equality.

Two AggregateQuerySnapshot instances are considered "equal" if they have underlying queries that compare equal, and the same data.

Firma:

export declare function aggregateQuerySnapshotEqual<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(left: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>, right: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>): boolean;

Parametri

Parametro	Tipo	Descrizione
Sinistra	AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType>	The first AggregateQuerySnapshot to compare.
Giusto	AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType>	The second AggregateQuerySnapshot to compare.

Ritorna:

boolean

true if the objects are "equal", as defined above, or false otherwise.

queryEqual(left, right)

Returns true if the provided queries point to the same collection and apply the same constraints.

Firma:

export declare function queryEqual<AppModelType, DbModelType extends DocumentData>(left: Query<AppModelType, DbModelType>, right: Query<AppModelType, DbModelType>): boolean;

Parametri

Parametro	Tipo	Descrizione
Sinistra	Domanda <AppModelType, DbModelType>	A Query to compare.
Giusto	Domanda <AppModelType, DbModelType>	A Query to compare.

Ritorna:

boolean

true if the references point to the same location in the same Firestore database.

refEqual(left, right)

Returns true if the provided references are equal.

Firma:

export declare function refEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>, right: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>): boolean;

Parametri

Parametro	Tipo	Descrizione
Sinistra	DocumentReference <AppModelType, DbModelType> | CollectionReference <AppModelType, DbModelType>	A reference to compare.
Giusto	DocumentReference <AppModelType, DbModelType> | CollectionReference <AppModelType, DbModelType>	A reference to compare.

Ritorna:

boolean

true if the references point to the same location in the same Firestore database.

snapshotEqual(left, right)

Returns true if the provided snapshots are equal.

Firma:

export declare function snapshotEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>, right: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>): boolean;

Parametri

Parametro	Tipo	Descrizione
Sinistra	DocumentSnapshot <AppModelType, DbModelType> | QuerySnapshot <AppModelType, DbModelType>	A snapshot to compare.
Giusto	DocumentSnapshot <AppModelType, DbModelType> | QuerySnapshot <AppModelType, DbModelType>	A snapshot to compare.

Ritorna:

boolean

true if the snapshots are equal.

function(limit, ...)

limit(limit)

Creates a QueryLimitConstraint that only returns the first matching documents.

Firma:

export declare function limit(limit: number): QueryLimitConstraint;

Parametri

Parametro	Tipo	Descrizione
limite	numero	The maximum number of items to return.

Ritorna:

QueryLimitConstraint

The created QueryLimitConstraint .

limitToLast(limit)

Creates a QueryLimitConstraint that only returns the last matching documents.

You must specify at least one orderBy clause for limitToLast queries, otherwise an exception will be thrown during execution.

Firma:

export declare function limitToLast(limit: number): QueryLimitConstraint;

Parametri

Parametro	Tipo	Descrizione
limite	numero	The maximum number of items to return.

Ritorna:

QueryLimitConstraint

The created QueryLimitConstraint .

function(logLevel, ...)

setLogLevel(logLevel)

Sets the verbosity of Cloud Firestore logs (debug, error, or silent).

Firma:

export declare function setLogLevel(logLevel: LogLevel): void;

Parametri

Parametro	Tipo	Descrizione
logLevel	LogLevel	The verbosity you set for activity and error logging. Can be any of the following values: debug for the most verbose logging level, primarily for debugging. error to log errors only. silent to turn off logging.

Ritorna:

vuoto

function(n, ...)

increment(n)

Returns a special value that can be used with setDoc() or updateDoc() that tells the server to increment the field's current value by the given value.

If either the operand or the current field value uses floating point precision, all arithmetic follows IEEE 754 semantics. If both values are integers, values outside of JavaScript's safe number range ( Number.MIN_SAFE_INTEGER to Number.MAX_SAFE_INTEGER ) are also subject to precision loss. Furthermore, once processed by the Firestore backend, all integer operations are capped between -2^63 and 2^63-1.

If the current field value is not of type number , or if the field does not yet exist, the transformation sets the field to the given value.

Firma:

export declare function increment(n: number): FieldValue;

Parametri

Parametro	Tipo	Descrizione
N	numero	The value to increment by.

Ritorna:

FieldValue

The FieldValue sentinel for use in a call to setDoc() or updateDoc()

function(query, ...)

getAggregateFromServer(query, aggregateSpec)

Calculates the specified aggregations over the documents in the result set of the given query without actually downloading the documents.

Using this function to perform aggregations is efficient because only the final aggregation values, not the documents' data, are downloaded. This function can perform aggregations of the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every invocation of this function necessarily involves a round trip to the server.

Firma:

export declare function getAggregateFromServer<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, aggregateSpec: AggregateSpecType): Promise<AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>>;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda <AppModelType, DbModelType>	The query whose result set is aggregated over.
aggregateSpec	AggregateSpecType	An AggregateSpec object that specifies the aggregates to perform over the result set. The AggregateSpec specifies aliases for each aggregate, which can be used to retrieve the aggregate result.

Ritorna:

Promise< AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType>>

Esempio

const aggregateSnapshot = await getAggregateFromServer(query, {
  countOfDocs: count(),
  totalHours: sum('hours'),
  averageScore: average('score')
});

const countOfDocs: number = aggregateSnapshot.data().countOfDocs;
const totalHours: number = aggregateSnapshot.data().totalHours;
const averageScore: number | null = aggregateSnapshot.data().averageScore;

getCountFromServer(query)

Calculates the number of documents in the result set of the given query without actually downloading the documents.

Using this function to count the documents is efficient because only the final count, not the documents' data, is downloaded. This function can count the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every invocation of this function necessarily involves a round trip to the server.

Firma:

export declare function getCountFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<AggregateQuerySnapshot<{
    count: AggregateField<number>;
}, AppModelType, DbModelType>>;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda <AppModelType, DbModelType>	The query whose result set size is calculated.

Ritorna:

Promise< AggregateQuerySnapshot <{ count: AggregateField <number>; }, AppModelType, DbModelType>>

A Promise that will be resolved with the count; the count can be retrieved from snapshot.data().count , where snapshot is the AggregateQuerySnapshot to which the returned Promise resolves.

getDocs(query)

Executes the query and returns the results as a QuerySnapshot .

Note: getDocs() attempts to provide up-to-date data when possible by waiting for data from the server, but it may return cached data or fail if you are offline and the server cannot be reached. To specify this behavior, invoke getDocsFromCache() or getDocsFromServer() .

Firma:

export declare function getDocs<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda <AppModelType, DbModelType>

Ritorna:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

getDocsFromCache(query)

Executes the query and returns the results as a QuerySnapshot from cache. Returns an empty result set if no documents matching the query are currently cached.

Firma:

export declare function getDocsFromCache<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda <AppModelType, DbModelType>

Ritorna:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

getDocsFromServer(query)

Executes the query and returns the results as a QuerySnapshot from the server. Returns an error if the network is not available.

Firma:

export declare function getDocsFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda <AppModelType, DbModelType>

Ritorna:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

onSnapshot(query, observer)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda <AppModelType, DbModelType>	The query to listen to.
osservatore	{ next?: (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; }	A single object containing next and error callbacks.

Ritorna:

Annulla l'iscrizione

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, options, observer)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda <AppModelType, DbModelType>	The query to listen to.
opzioni	SnapshotListenOptions	Options controlling the listen behavior.
osservatore	{ next?: (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; }	A single object containing next and error callbacks.

Ritorna:

Annulla l'iscrizione

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, onNext, onError, onCompletion)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda <AppModelType, DbModelType>	The query to listen to.
onNext	(snapshot: QuerySnapshot <AppModelType, DbModelType>) => void	A callback to be called every time a new QuerySnapshot is available.
onError	(error: FirestoreError ) => void	A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
al termine	() => void	Can be provided, but will not be called since streams are never ending.

Ritorna:

Annulla l'iscrizione

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, options, onNext, onError, onCompletion)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda <AppModelType, DbModelType>	The query to listen to.
opzioni	SnapshotListenOptions	Options controlling the listen behavior.
onNext	(snapshot: QuerySnapshot <AppModelType, DbModelType>) => void	A callback to be called every time a new QuerySnapshot is available.
onError	(error: FirestoreError ) => void	A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
al termine	() => void	Can be provided, but will not be called since streams are never ending.

Ritorna:

Annulla l'iscrizione

An unsubscribe function that can be called to cancel the snapshot listener.

query(query, compositeFilter, queryConstraints)

Creates a new immutable instance of Query that is extended to also include additional query constraints.

Firma:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<AppModelType, DbModelType>;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda <AppModelType, DbModelType>	The Query instance to use as a base for the new constraints.
compositeFilter	QueryCompositeFilterConstraint	The QueryCompositeFilterConstraint to apply. Create QueryCompositeFilterConstraint using and() or or() .
queryConstraints	QueryNonFilterConstraint []	Additional QueryNonFilterConstraint s to apply (eg orderBy() , limit() ).

Ritorna:

Domanda <AppModelType, DbModelType>

Exceptions

if any of the provided query constraints cannot be combined with the existing or new constraints.

query(query, queryConstraints)

Creates a new immutable instance of Query that is extended to also include additional query constraints.

Firma:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, ...queryConstraints: QueryConstraint[]): Query<AppModelType, DbModelType>;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda <AppModelType, DbModelType>	The Query instance to use as a base for the new constraints.
queryConstraints	QueryConstraint []	The list of QueryConstraint s to apply.

Ritorna:

Domanda <AppModelType, DbModelType>

Exceptions

if any of the provided query constraints cannot be combined with the existing or new constraints.

function(queryConstraints, ...)

and(queryConstraints)

Creates a new QueryCompositeFilterConstraint that is a conjunction of the given filter constraints. A conjunction filter includes a document if it satisfies all of the given filters.

Firma:

export declare function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

Parametri

Parametro	Tipo	Descrizione
queryConstraints	QueryFilterConstraint []	Opzionale. The list of QueryFilterConstraint s to perform a conjunction for. These must be created with calls to where() , O() , or and() .

Ritorna:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

or(queryConstraints)

Creates a new QueryCompositeFilterConstraint that is a disjunction of the given filter constraints. A disjunction filter includes a document if it satisfies any of the given filters.

Firma:

export declare function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

Parametri

Parametro	Tipo	Descrizione
queryConstraints	QueryFilterConstraint []	Opzionale. The list of QueryFilterConstraint s to perform a disjunction for. These must be created with calls to where() , O() , or and() .

Ritorna:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

function(reference, ...)

addDoc(reference, data)

Add a new document to specified CollectionReference with the given data, assigning it a document ID automatically.

Firma:

export declare function addDoc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<DocumentReference<AppModelType, DbModelType>>;

Parametri

Parametro	Tipo	Descrizione
riferimento	CollectionReference <AppModelType, DbModelType>	A reference to the collection to add this document to.
dati	WithFieldValue <AppModelType>	An Object containing the data for the new document.

Ritorna:

Promise< DocumentReference <AppModelType, DbModelType>>

A Promise resolved with a DocumentReference pointing to the newly created document after it has been written to the backend (Note that it won't resolve while you're offline).

collection(reference, path, pathSegments)

Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path.

Firma:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

Parametri

Parametro	Tipo	Descrizione
riferimento	CollectionReference <AppModelType, DbModelType>	A reference to a collection.
sentiero	corda	A slash-separated path to a collection.
pathSegments	corda[]	Additional path segments to apply relative to the first argument.

Ritorna:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

Exceptions

If the final path has an even number of segments and does not point to a collection.

collection(reference, path, pathSegments)

Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path.

Firma:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

Parametri

Parametro	Tipo	Descrizione
riferimento	DocumentReference <AppModelType, DbModelType>	A reference to a Firestore document.
sentiero	corda	A slash-separated path to a collection.
pathSegments	corda[]	Additional path segments that will be applied relative to the first argument.

Ritorna:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

Exceptions

If the final path has an even number of segments and does not point to a collection.

deleteDoc(reference)

Deletes the document referred to by the specified DocumentReference .

Firma:

export declare function deleteDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<void>;

Parametri

Parametro	Tipo	Descrizione
riferimento	DocumentReference <AppModelType, DbModelType>	A reference to the document to delete.

Ritorna:

Promise<void>

A Promise resolved once the document has been successfully deleted from the backend (note that it won't resolve while you're offline).

doc(reference, path, pathSegments)

Gets a DocumentReference instance that refers to a document within reference at the specified relative path. If no path is specified, an automatically-generated unique ID will be used for the returned DocumentReference .

Firma:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path?: string, ...pathSegments: string[]): DocumentReference<AppModelType, DbModelType>;

Parametri

Parametro	Tipo	Descrizione
riferimento	CollectionReference <AppModelType, DbModelType>	A reference to a collection.
sentiero	corda	A slash-separated path to a document. Has to be omitted to use auto-genrated IDs.
pathSegments	corda[]	Additional path segments that will be applied relative to the first argument.

Ritorna:

DocumentReference <AppModelType, DbModelType>

The DocumentReference instance.

Exceptions

If the final path has an odd number of segments and does not point to a document.

doc(reference, path, pathSegments)

Gets a DocumentReference instance that refers to a document within reference at the specified relative path.

Firma:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

Parametri

Parametro	Tipo	Descrizione
riferimento	DocumentReference <AppModelType, DbModelType>	A reference to a Firestore document.
sentiero	corda	A slash-separated path to a document.
pathSegments	corda[]	Additional path segments that will be applied relative to the first argument.

Ritorna:

DocumentReference < DocumentData , DocumentData >

The DocumentReference instance.

Exceptions

If the final path has an odd number of segments and does not point to a document.

getDoc(reference)

Reads the document referred to by this DocumentReference .

Note: getDoc() attempts to provide up-to-date data when possible by waiting for data from the server, but it may return cached data or fail if you are offline and the server cannot be reached. To specify this behavior, invoke getDocFromCache() or getDocFromServer() .

Firma:

export declare function getDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

Parametri

Parametro	Tipo	Descrizione
riferimento	DocumentReference <AppModelType, DbModelType>	The reference of the document to fetch.

Ritorna:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

getDocFromCache(reference)

Reads the document referred to by this DocumentReference from cache. Returns an error if the document is not currently cached.

Firma:

export declare function getDocFromCache<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

Parametri

Parametro	Tipo	Descrizione
riferimento	DocumentReference <AppModelType, DbModelType>

Ritorna:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

getDocFromServer(reference)

Reads the document referred to by this DocumentReference from the server. Returns an error if the network is not available.

Firma:

export declare function getDocFromServer<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

Parametri

Parametro	Tipo	Descrizione
riferimento	DocumentReference <AppModelType, DbModelType>

Ritorna:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

onSnapshot(reference, observer)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
riferimento	DocumentReference <AppModelType, DbModelType>	A reference to the document to listen to.
osservatore	{ next?: (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; }	A single object containing next and error callbacks.

Ritorna:

Annulla l'iscrizione

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, options, observer)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
riferimento	DocumentReference <AppModelType, DbModelType>	A reference to the document to listen to.
opzioni	SnapshotListenOptions	Options controlling the listen behavior.
osservatore	{ next?: (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; }	A single object containing next and error callbacks.

Ritorna:

Annulla l'iscrizione

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, onNext, onError, onCompletion)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
riferimento	DocumentReference <AppModelType, DbModelType>	A reference to the document to listen to.
onNext	(snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void	A callback to be called every time a new DocumentSnapshot is available.
onError	(error: FirestoreError ) => void	A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
al termine	() => void	Can be provided, but will not be called since streams are never ending.

Ritorna:

Annulla l'iscrizione

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, options, onNext, onError, onCompletion)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
riferimento	DocumentReference <AppModelType, DbModelType>	A reference to the document to listen to.
opzioni	SnapshotListenOptions	Options controlling the listen behavior.
onNext	(snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void	A callback to be called every time a new DocumentSnapshot is available.
onError	(error: FirestoreError ) => void	A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
al termine	() => void	Can be provided, but will not be called since streams are never ending.

Ritorna:

Annulla l'iscrizione

An unsubscribe function that can be called to cancel the snapshot listener.

setDoc(reference, data)

Writes to the document referred to by this DocumentReference . If the document does not yet exist, it will be created.

Firma:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<void>;

Parametri

Parametro	Tipo	Descrizione
riferimento	DocumentReference <AppModelType, DbModelType>	A reference to the document to write.
dati	WithFieldValue <AppModelType>	A map of the fields and values for the document.

Ritorna:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

setDoc(reference, data, options)

Writes to the document referred to by the specified DocumentReference . If the document does not yet exist, it will be created. If you provide merge or mergeFields , the provided data can be merged into an existing document.

Firma:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): Promise<void>;

Parametri

Parametro	Tipo	Descrizione
riferimento	DocumentReference <AppModelType, DbModelType>	A reference to the document to write.
dati	PartialWithFieldValue <AppModelType>	A map of the fields and values for the document.
opzioni	SetOptions	An object to configure the set behavior.

Ritorna:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

updateDoc(reference, data)

Updates fields in the document referred to by the specified DocumentReference . The update will fail if applied to a document that does not exist.

Firma:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): Promise<void>;

Parametri

Parametro	Tipo	Descrizione
riferimento	DocumentReference <AppModelType, DbModelType>	A reference to the document to update.
dati	UpdateData <DbModelType>	An object containing the fields and values with which to update the document. Fields can contain dots to reference nested fields within the document.

Ritorna:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

updateDoc(reference, field, value, moreFieldsAndValues)

Updates fields in the document referred to by the specified DocumentReference The update will fail if applied to a document that does not exist.

Nested fields can be updated by providing dot-separated field path strings or by providing FieldPath objects.

Firma:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;

Parametri

Parametro	Tipo	Descrizione
riferimento	DocumentReference <AppModelType, DbModelType>	A reference to the document to update.
campo	string | FieldPath	The first field to update.
valore	sconosciuto	The first value.
moreFieldsAndValues	sconosciuto[]	Additional key value pairs.

Ritorna:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

function(settings, ...)

memoryLocalCache(settings)

Creates an instance of MemoryLocalCache . The instance can be set to FirestoreSettings.cache to tell the SDK which cache layer to use.

Firma:

export declare function memoryLocalCache(settings?: MemoryCacheSettings): MemoryLocalCache;

Parametri

Parametro	Tipo	Descrizione
impostazioni	MemoryCacheSettings

Ritorna:

MemoryLocalCache

memoryLruGarbageCollector(settings)

Creates an instance of MemoryLruGarbageCollector .

A target size can be specified as part of the setting parameter. The collector will start deleting documents once the cache size exceeds the given size. The default cache size is 40MB (40 * 1024 * 1024 bytes).

Firma:

export declare function memoryLruGarbageCollector(settings?: {
    cacheSizeBytes?: number;
}): MemoryLruGarbageCollector;

Parametri

Parametro	Tipo	Descrizione
impostazioni	{ cacheSizeBytes?: number; }

Ritorna:

MemoryLruGarbageCollector

persistentLocalCache(settings)

Creates an instance of PersistentLocalCache . The instance can be set to FirestoreSettings.cache to tell the SDK which cache layer to use.

Persistent cache cannot be used in a Node.js environment.

Firma:

export declare function persistentLocalCache(settings?: PersistentCacheSettings): PersistentLocalCache;

Parametri

Parametro	Tipo	Descrizione
impostazioni	PersistentCacheSettings

Ritorna:

PersistentLocalCache

persistentSingleTabManager(settings)

Creates an instance of PersistentSingleTabManager .

Firma:

export declare function persistentSingleTabManager(settings: PersistentSingleTabManagerSettings | undefined): PersistentSingleTabManager;

Parametri

Parametro	Tipo	Descrizione
impostazioni	PersistentSingleTabManagerSettings | non definito	Configures the created tab manager.

Ritorna:

PersistentSingleTabManager

function(snapshot, ...)

endAt(snapshot)

Creates a QueryEndAtConstraint that modifies the result set to end at the provided document (inclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

Firma:

export declare function endAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

Parametri

Parametro	Tipo	Descrizione
istantanea	DocumentSnapshot <AppModelType, DbModelType>	The snapshot of the document to end at.

Ritorna:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(snapshot)

Creates a QueryEndAtConstraint that modifies the result set to end before the provided document (exclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

Firma:

export declare function endBefore<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

Parametri

Parametro	Tipo	Descrizione
istantanea	DocumentSnapshot <AppModelType, DbModelType>	The snapshot of the document to end before.

Ritorna:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(snapshot)

Creates a QueryStartAtConstraint that modifies the result set to start after the provided document (exclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

Firma:

export declare function startAfter<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

Parametri

Parametro	Tipo	Descrizione
istantanea	DocumentSnapshot <AppModelType, DbModelType>	The snapshot of the document to start after.

Ritorna:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(snapshot)

Creates a QueryStartAtConstraint that modifies the result set to start at the provided document (inclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

Firma:

export declare function startAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

Parametri

Parametro	Tipo	Descrizione
istantanea	DocumentSnapshot <AppModelType, DbModelType>	The snapshot of the document to start at.

Ritorna:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

CACHE_SIZE_UNLIMITED

Constant used to indicate the LRU garbage collection should be disabled. Set this value as the cacheSizeBytes on the settings passed to the Firestore instance.

Firma:

CACHE_SIZE_UNLIMITED = -1

AddPrefixToKeys

Returns a new map where every key is prefixed with the outer key appended to a dot.

Firma:

export declare type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
    [K in keyof T & string as `${Prefix}.${K}`]+?: string extends K ? any : T[K];
};

AggregateFieldType

The union of all AggregateField types that are supported by Firestore.

Firma:

export declare type AggregateFieldType = ReturnType<typeof sum> | ReturnType<typeof average> | ReturnType<typeof count>;

AggregateSpecData

A type whose keys are taken from an AggregateSpec , and whose values are the result of the aggregation performed by the corresponding AggregateField from the input AggregateSpec .

Firma:

export declare type AggregateSpecData<T extends AggregateSpec> = {
    [P in keyof T]: T[P] extends AggregateField<infer U> ? U : never;
};

AggregateType

Union type representing the aggregate type to be performed.

Firma:

export declare type AggregateType = 'count' | 'avg' | 'sum';

ChildUpdateFields

Helper for calculating the nested fields for a given type T1. This is needed to distribute union types such as undefined | {...} (happens for optional props) or {a: A} | {b: B} .

In this use case, V is used to distribute the union types of T[K] on Record , since T[K] is evaluated as an expression and not distributed.

See https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types

Firma:

export declare type ChildUpdateFields<K extends string, V> = V extends Record<string, unknown> ? AddPrefixToKeys<K, UpdateData<V>> : never;

DocumentChangeType

The type of a DocumentChange may be 'added', 'removed', or 'modified'.

Firma:

export declare type DocumentChangeType = 'added' | 'removed' | 'modified';

FirestoreErrorCode

The set of Firestore status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Possible values: - 'cancelled': The operation was cancelled (typically by the caller). - 'unknown': Unknown error or an error from a different error domain. - 'invalid-argument': Client specified an invalid argument. Note that this differs from 'failed-precondition'. 'invalid-argument' indicates arguments that are problematic regardless of the state of the system (eg an invalid field name). - 'deadline-exceeded': Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. - 'not-found': Some requested document was not found. - 'already-exists': Some document that we attempted to create already exists. - 'permission-denied': The caller does not have permission to execute the specified operation. - 'resource-exhausted': Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. - 'failed-precondition': Operation was rejected because the system is not in a state required for the operation's execution. - 'aborted': The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. - 'out-of-range': Operation was attempted past the valid range. - 'unimplemented': Operation is not implemented or not supported/enabled. - 'internal': Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. - 'unavailable': The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff. - 'data-loss': Unrecoverable data loss or corruption. - 'unauthenticated': The request does not have valid authentication credentials for the operation.

Firma:

export declare type FirestoreErrorCode = 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';

FirestoreLocalCache

Union type from all supported SDK cache layer.

Firma:

export declare type FirestoreLocalCache = MemoryLocalCache | PersistentLocalCache;

ListenSource

Describe the source a query listens to.

Set to default to listen to both cache and server changes. Set to cache to listen to changes in cache only.

Firma:

export declare type ListenSource = 'default' | 'cache';

MemoryGarbageCollector

Union type from all support gabage collectors for memory local cache.

Firma:

export declare type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;

NestedUpdateFields

For each field (eg 'bar'), find all nested keys (eg { 'bar.baz': T1, 'bar.qux': T2 } ). Intersect them together to make a single map containing all possible keys that are all marked as optional

Firma:

export declare type NestedUpdateFields<T extends Record<string, unknown>> = UnionToIntersection<{
    [K in keyof T & string]: ChildUpdateFields<K, T[K]>;
}[keyof T & string]>;

OrderByDirection

The direction of a orderBy() clause is specified as 'desc' or 'asc' (descending or ascending).

Firma:

export declare type OrderByDirection = 'desc' | 'asc';

PartialWithFieldValue

Similar to Typescript's Partial<T> , but allows nested fields to be omitted and FieldValues to be passed in as property values.

Firma:

export declare type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: PartialWithFieldValue<T[K]> | FieldValue;
} : never);

PersistentTabManager

A union of all available tab managers.

Firma:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

Primitivo

Primitive types.

Firma:

export declare type Primitive = string | number | boolean | undefined | null;

QueryConstraintType

Describes the different query constraints available in this SDK.

Firma:

export declare type QueryConstraintType = 'where' | 'orderBy' | 'limit' | 'limitToLast' | 'startAt' | 'startAfter' | 'endAt' | 'endBefore';

QueryFilterConstraint

QueryFilterConstraint is a helper union type that represents QueryFieldFilterConstraint and QueryCompositeFilterConstraint .

Firma:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QueryNonFilterConstraint

QueryNonFilterConstraint is a helper union type that represents QueryConstraints which are used to narrow or order the set of documents, but that do not explicitly filter on a document field. QueryNonFilterConstraint s are created by invoking orderBy() , iniziare a() , startAfter() , endBefore() , endAt() , limit() or limitToLast() and can then be passed to query() to create a new query instance that also contains the QueryConstraint .

Firma:

export declare type QueryNonFilterConstraint = QueryOrderByConstraint | QueryLimitConstraint | QueryStartAtConstraint | QueryEndAtConstraint;

SetOptions

An options object that configures the behavior of setDoc() , and calls. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety by providing a SetOptions with merge: true .

Firma:

export declare type SetOptions = {
    readonly merge?: boolean;
} | {
    readonly mergeFields?: Array<string | FieldPath>;
};

TaskState

Represents the state of bundle loading tasks.

Both 'Error' and 'Success' are sinking state: task will abort or complete and there will be no more updates after they are reported.

Firma:

export declare type TaskState = 'Error' | 'Running' | 'Success';

UnionToIntersection

Given a union type U = T1 | T2 | ... , returns an intersected type (T1 & T2 & ...) .

Uses distributive conditional types and inference from conditional types. This works because multiple candidates for the same type variable in contra-variant positions causes an intersection type to be inferred. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection -tipo

Firma:

export declare type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;

UpdateData

Update data (for use with updateDoc() ) that consists of field paths (eg 'foo' or 'foo.baz') mapped to values. Fields that contain dots reference nested fields within the document. FieldValues can be passed in as property values.

Firma:

export declare type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: UpdateData<T[K]> | FieldValue;
} & NestedUpdateFields<T> : Partial<T>;

WhereFilterOp

Filter conditions in a where() clause are specified using the strings '&lt;', '&lt;=', '==', '!=', '&gt;=', '&gt;', 'array-contains', 'in', 'array-contains-any', and 'not-in'.

Firma:

export declare type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-contains' | 'in' | 'array-contains-any' | 'not-in';

WithFieldValue

Allows FieldValues to be passed in as a property value while maintaining type safety.

Firma:

export declare type WithFieldValue<T> = T | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]: WithFieldValue<T[K]> | FieldValue;
} : never);