@firebase/firestore

Funktionen

Funktion	Beschreibung
Funktion(App, ...)
getFirestore(App)	Gibt die vorhandene Standard- Firestore- Instanz zurück, die der bereitgestellten FirebaseApp zugeordnet ist . Wenn keine Instanz vorhanden ist, wird eine neue Instanz mit Standardeinstellungen initialisiert.
getFirestore(app, Datenbank-ID)	(BETA) Gibt die vorhandene benannte Firestore- Instanz zurück, die der bereitgestellten FirebaseApp zugeordnet ist . Wenn keine Instanz vorhanden ist, wird eine neue Instanz mit Standardeinstellungen initialisiert.
initializeFirestore(app, Einstellungen, Datenbank-ID)	Initialisiert eine neue Instanz von Firestore mit den bereitgestellten Einstellungen. Kann nur vor jeder anderen Funktion aufgerufen werden, einschließlich getFirestore() . Wenn die benutzerdefinierten Einstellungen leer sind, entspricht diese Funktion dem Aufruf von getFirestore() .
Funktion(Firestore, ...)
clearIndexedDbPersistence(Firestore)	Löscht den persistenten Speicher. Dazu gehören ausstehende Schreibvorgänge und zwischengespeicherte Dokumente. Muss aufgerufen werden, während die Firestore- Instanz nicht gestartet ist (nachdem die App beendet wurde oder wenn die App zum ersten Mal initialisiert wurde). Beim Start muss diese Funktion vor anderen Funktionen (außer initializeFirestore() oder getFirestore()) aufgerufen werden. )). Wenn die Firestore- Instanz noch ausgeführt wird, wird das Versprechen mit dem Fehlercode failed-precondition abgelehnt. Hinweis: clearIndexedDbPersistence() soll in erster Linie dabei helfen, zuverlässige Tests zu schreiben, die Cloud Firestore verwenden. Es verwendet einen effizienten Mechanismus zum Löschen vorhandener Daten, versucht jedoch nicht, zwischengespeicherte Daten sicher zu überschreiben oder auf andere Weise unwiederbringlich zu machen. Für Anwendungen, die empfindlich auf die Offenlegung zwischengespeicherter Daten zwischen Benutzersitzungen reagieren, empfehlen wir dringend, die Persistenz überhaupt nicht zu aktivieren.
Sammlung (Firestore, Pfad, Pfadsegmente)	Ruft eine CollectionReference Instanz ab, die auf die Sammlung am angegebenen absoluten Pfad verweist.
CollectionGroup(Firestore, CollectionId)	Erstellt eine neue Query und gibt sie zurück, die alle Dokumente in der Datenbank enthält, die in einer Sammlung oder Untersammlung mit der angegebenen collectionId enthalten sind.
connectFirestoreEmulator(Firestore, Host, Port, Optionen)	Ändern Sie diese Instanz, um mit dem Cloud Firestore-Emulator zu kommunizieren. Hinweis: Dies muss aufgerufen werden, bevor diese Instanz zum Ausführen von Vorgängen verwendet wurde.
disableNetwork(Firestore)	Deaktiviert die Netzwerknutzung für diese Instanz. Es kann über enableNetwork() wieder aktiviert werden. . Während das Netzwerk deaktiviert ist, geben alle Snapshot-Listener sowie getDoc() oder getDocs() Aufrufe Ergebnisse aus dem Cache zurück und alle Schreibvorgänge werden in die Warteschlange gestellt, bis das Netzwerk wiederhergestellt ist.
doc(firestore, path, pathSegments)	Ruft eine DocumentReference Instanz ab, die auf das Dokument im angegebenen absoluten Pfad verweist.
enableIndexedDbPersistence(firestore, persistenceSettings)	Versucht, wenn möglich, dauerhaften Speicher zu aktivieren. Bei einem Fehler lehnt enableIndexedDbPersistence() das Versprechen ab oder löst eine Ausnahme aus. Dass dies fehlschlagen kann, kann mehrere Gründe haben, die anhand des code identifiziert werden können. * failed-precondition: Die App ist bereits in einem anderen Browser-Tab geöffnet. * nicht implementiert: Der Browser ist mit der Offline-Persistenz-Implementierung nicht kompatibel. Beachten Sie, dass die Firestore- Instanz auch nach einem Fehler weiterhin nutzbar bleibt, die Offline-Persistenz jedoch deaktiviert wird. Hinweis: enableIndexedDbPersistence() muss vor allen anderen Funktionen (außer initializeFirestore()) aufgerufen werden. , getFirestore() oder clearIndexedDbPersistence() . Persistenz kann in einer Node.js-Umgebung nicht verwendet werden.
enableMultiTabIndexedDbPersistence(Firestore)	Versucht, wenn möglich, den persistenten Speicher mit mehreren Registerkarten zu aktivieren. Wenn die Funktion auf allen Registerkarten aktiviert ist, haben alle Vorgänge einen gemeinsamen Zugriff auf die lokale Persistenz, einschließlich der gemeinsamen Ausführung von Abfragen und latenzkompensierten lokalen Dokumentaktualisierungen über alle verbundenen Instanzen hinweg. Bei einem Fehler lehnt enableMultiTabIndexedDbPersistence() das Versprechen ab oder löst eine Ausnahme aus. Dass dies fehlschlagen kann, kann mehrere Gründe haben, die anhand des code identifiziert werden können. * failed-precondition: Die App ist bereits in einem anderen Browser-Tab geöffnet und Multi-Tab ist nicht aktiviert. * nicht implementiert: Der Browser ist mit der Offline-Persistenz-Implementierung nicht kompatibel. Beachten Sie, dass die Firestore- Instanz auch nach einem Fehler weiterhin nutzbar bleibt, die Offline-Persistenz jedoch deaktiviert wird.
enableNetwork(Firestore)	Aktiviert die Nutzung des Netzwerks für diese Firestore- Instanz nach einem vorherigen Aufruf von „disableNetwork()“ wieder. .
getPersistentCacheIndexManager(firestore)	Gibt den vom angegebenen Firestore Objekt verwendeten PersistentCache-Index-Manager zurück. Die PersistentCacheIndexManager Instanz oder null , wenn der lokale persistente Speicher nicht verwendet wird.
LoadBundle(Firestore, BundleData)	Lädt ein Firestore-Bundle in den lokalen Cache.
NamedQuery(Firestore, Name)	Liest eine Firestore- Abfrage aus dem lokalen Cache, identifiziert durch den angegebenen Namen. Die benannten Abfragen werden auf der Serverseite (zusammen mit den resultierenden Dokumenten) in Bundles gepackt und mit loadBundle in den lokalen Cache geladen. Sobald Sie sich im lokalen Cache befinden, verwenden Sie diese Methode, um eine Abfrage nach Namen zu extrahieren.
onSnapshotsInSync(Firestore, Beobachter)	Fügt einen Listener für ein Snapshots-in-sync-Ereignis hinzu. Das Snapshots-in-Sync-Ereignis zeigt an, dass alle von einer bestimmten Änderung betroffenen Listener ausgelöst wurden, auch wenn eine einzelne vom Server generierte Änderung mehrere Listener betrifft. HINWEIS: Das Snapshots-in-sync-Ereignis zeigt nur an, dass Listener miteinander synchron sind, hat jedoch keinen Bezug dazu, ob diese Snapshots mit dem Server synchron sind. Verwenden Sie SnapshotMetadata in den einzelnen Listenern, um zu bestimmen, ob ein Snapshot aus dem Cache oder vom Server stammt.
onSnapshotsInSync(Firestore, onSync)	Fügt einen Listener für ein Snapshots-in-sync-Ereignis hinzu. Das Snapshots-in-Sync-Ereignis zeigt an, dass alle von einer bestimmten Änderung betroffenen Listener ausgelöst wurden, auch wenn eine einzelne vom Server generierte Änderung mehrere Listener betrifft. HINWEIS: Das Snapshots-in-sync-Ereignis zeigt nur an, dass Listener miteinander synchron sind, hat jedoch keinen Bezug dazu, ob diese Snapshots mit dem Server synchron sind. Verwenden Sie SnapshotMetadata in den einzelnen Listenern, um zu bestimmen, ob ein Snapshot aus dem Cache oder vom Server stammt.
runTransaction(firestore, updateFunction, Optionen)	Führt die angegebene updateFunction aus und versucht dann, die innerhalb der Transaktion vorgenommenen Änderungen festzuschreiben. Wenn sich ein innerhalb der Transaktion gelesenes Dokument geändert hat, wiederholt Cloud Firestore die updateFunction . Wenn der Commit nach fünf Versuchen fehlschlägt, schlägt die Transaktion fehl. Die maximal zulässige Anzahl von Schreibvorgängen in einer einzelnen Transaktion beträgt 500.
setIndexConfiguration(Firestore, Konfiguration)	(BETA) Konfiguriert die Indizierung für die lokale Abfrageausführung. Alle vorherigen Indexkonfigurationen werden überschrieben. Das Promise wird aufgelöst, sobald die Indexkonfiguration beibehalten wurde. Die Indexeinträge selbst werden asynchron erstellt. Sie können Abfragen, die eine Indizierung erfordern, weiterhin verwenden, auch wenn die Indizes noch nicht verfügbar sind. Die Abfrageausführung beginnt automatisch mit dem Index, sobald die Indexeinträge geschrieben wurden. Indizes werden nur mit IndexedDb-Persistenz unterstützt. Wenn IndexedDb nicht aktiviert ist, wird jede Indexkonfiguration ignoriert.
setIndexConfiguration(firestore, json)	(BETA) Konfiguriert die Indizierung für die lokale Abfrageausführung. Alle vorherigen Indexkonfigurationen werden überschrieben. Das Promise wird aufgelöst, sobald die Indexkonfiguration beibehalten wurde. Die Indexeinträge selbst werden asynchron erstellt. Sie können Abfragen, die eine Indizierung erfordern, weiterhin verwenden, auch wenn die Indizes noch nicht verfügbar sind. Die Abfrageausführung beginnt automatisch mit dem Index, sobald die Indexeinträge geschrieben wurden. Indizes werden nur mit IndexedDb-Persistenz unterstützt. Rufen Sie entweder enableIndexedDbPersistence() oder enableMultiTabIndexedDbPersistence() auf, bevor Sie eine Indexkonfiguration festlegen. Wenn IndexedDb nicht aktiviert ist, wird jede Indexkonfiguration ignoriert. Die Methode akzeptiert das von der Firebase-CLI exportierte JSON-Format ( firebase firestore:indexes ). Wenn das JSON-Format ungültig ist, gibt diese Methode einen Fehler aus.
beenden(Firestore)	Beendet die bereitgestellte Firestore- Instanz. Nach dem Aufruf von terminate() darf nur die Funktion clearIndexedDbPersistence() verwendet werden. Jede andere Funktion löst einen FirestoreError aus. Um nach der Beendigung neu zu starten, erstellen Sie mit getFirestore() eine neue Instanz von FirebaseFirestore. . Durch die Beendigung werden keine ausstehenden Schreibvorgänge abgebrochen, und alle Zusagen, die auf eine Antwort vom Server warten, werden nicht aufgelöst. Wenn Sie die Persistenz aktiviert haben, wird diese Instanz beim nächsten Start wieder diese Schreibvorgänge an den Server senden. Hinweis: Unter normalen Umständen ist der Aufruf von terminate() nicht erforderlich. Diese Funktion ist nur dann nützlich, wenn Sie diese Instanz zwingen möchten, alle ihre Ressourcen freizugeben, oder in Kombination mit clearIndexedDbPersistence() sicherstellen möchten, dass der gesamte lokale Status zwischen Testläufen zerstört wird.
waitForPendingWrites(Firestore)	Wartet, bis alle aktuell ausstehenden Schreibvorgänge für den aktiven Benutzer vom Backend bestätigt wurden. Das zurückgegebene Versprechen wird sofort aufgelöst, wenn keine ausstehenden Schreibvorgänge vorhanden sind. Andernfalls wartet das Versprechen auf alle zuvor ausgegebenen Schreibvorgänge (einschließlich der in einer vorherigen App-Sitzung geschriebenen), aber nicht auf Schreibvorgänge, die nach dem Aufruf der Funktion hinzugefügt wurden. Wenn Sie auf weitere Schreibvorgänge warten möchten, rufen Sie waitForPendingWrites() erneut auf. Alle ausstehenden waitForPendingWrites() Zusagen werden bei Benutzeränderungen abgelehnt.
writeBatch(Firestore)	Erstellt einen Schreibstapel, der zum Durchführen mehrerer Schreibvorgänge als einzelne atomare Operation verwendet wird. Die maximal zulässige Anzahl von Schreibvorgängen in einem einzelnen WriteBatch beträgt 500. Im Gegensatz zu Transaktionen werden Schreibbatches offline gespeichert und sind daher vorzuziehen, wenn Sie Ihre Schreibvorgänge nicht an Lesedaten binden müssen.
Funktion()
zählen()	Erstellen Sie ein AggregateField-Objekt, mit dem die Anzahl der Dokumente im Ergebnissatz einer Abfrage berechnet werden kann.
deleteField()	Gibt einen Sentinel zur Verwendung mit updateDoc() oder setDoc() mit {merge: true} zurück, um ein Feld zum Löschen zu markieren.
Dokument Identifikation()	Gibt einen speziellen Sentinel- FieldPath zurück, um auf die ID eines Dokuments zu verweisen. Es kann in Abfragen zum Sortieren oder Filtern nach der Dokument-ID verwendet werden.
getFirestore()	Gibt die vorhandene Standard- Firestore- Instanz zurück, die der Standard- FirebaseApp zugeordnet ist . Wenn keine Instanz vorhanden ist, wird eine neue Instanz mit Standardeinstellungen initialisiert.
MemoryEagerGarbageCollector()	Erstellt eine Instanz von MemoryEagerGarbageCollector . Dies ist auch der Standard-Garbage Collector, sofern nicht ausdrücklich etwas anderes angegeben ist.
persistentMultipleTabManager()	Erstellt eine Instanz von PersistentMultipleTabManager .
serverTimestamp()	Gibt einen Sentinel zurück, der mit setDoc() oder updateDoc() verwendet wird, um einen vom Server generierten Zeitstempel in die geschriebenen Daten aufzunehmen.
Funktion(Datenbank-ID, ...)
getFirestore(Datenbank-ID)	(BETA) Gibt die vorhandene benannte Firestore- Instanz zurück, die der Standard -FirebaseApp zugeordnet ist . Wenn keine Instanz vorhanden ist, wird eine neue Instanz mit Standardeinstellungen initialisiert.
Funktion(Elemente, ...)
arrayRemove(elemente)	Gibt einen speziellen Wert zurück, der mit setDoc() verwendet werden kann oder der den Server anweist, die angegebenen Elemente aus jedem Array-Wert zu entfernen, der bereits auf dem Server vorhanden ist. Alle Instanzen jedes angegebenen Elements werden aus dem Array entfernt. Wenn das zu ändernde Feld nicht bereits ein Array ist, wird es mit einem leeren Array überschrieben.
arrayUnion(elemente)	Gibt einen speziellen Wert zurück, der mit setDoc() oder updateDoc() verwendet werden kann und den Server anweist, die angegebenen Elemente mit jedem Array-Wert zu vereinen, der bereits auf dem Server vorhanden ist. Jedes angegebene Element, das noch nicht im Array vorhanden ist, wird am Ende hinzugefügt. Wenn das zu ändernde Feld nicht bereits ein Array ist, wird es mit einem Array überschrieben, das genau die angegebenen Elemente enthält.
Funktion(Feld, ...)
Durchschnitt(Feld)	Erstellen Sie ein AggregateField-Objekt, das zur Berechnung des Durchschnitts eines angegebenen Felds über einen Bereich von Dokumenten im Ergebnissatz einer Abfrage verwendet werden kann.
Summe(Feld)	Erstellen Sie ein AggregateField-Objekt, mit dem die Summe eines angegebenen Felds über einen Bereich von Dokumenten im Ergebnissatz einer Abfrage berechnet werden kann.
Funktion(fieldPath, ...)
orderBy(fieldPath, DirectionStr)	Erstellt eine QueryOrderByConstraint , die das Abfrageergebnis nach dem angegebenen Feld sortiert, optional in absteigender Reihenfolge statt aufsteigend. Hinweis: Dokumente, die das angegebene Feld nicht enthalten, sind im Abfrageergebnis nicht vorhanden.
where(fieldPath, opStr, value)	Erstellt eine QueryFieldFilterConstraint , die erzwingt, dass Dokumente das angegebene Feld enthalten müssen und dass der Wert die bereitgestellte Beziehungsbeschränkung erfüllen muss.
Funktion(Feldwerte, ...)
endAt(fieldValues)	Erstellt eine QueryEndAtConstraint , die den Ergebnissatz so ändert, dass er bei den bereitgestellten Feldern relativ zur Reihenfolge der Abfrage endet. Die Reihenfolge der Feldwerte muss mit der Reihenfolge der order by-Klauseln der Abfrage übereinstimmen.
endBefore(fieldValues)	Erstellt eine QueryEndAtConstraint , die die Ergebnismenge so ändert, dass sie relativ zur Reihenfolge der Abfrage vor den bereitgestellten Feldern endet. Die Reihenfolge der Feldwerte muss mit der Reihenfolge der order by-Klauseln der Abfrage übereinstimmen.
startAfter(fieldValues)	Erstellt eine QueryStartAtConstraint , die den Ergebnissatz so ändert, dass er nach den bereitgestellten Feldern relativ zur Reihenfolge der Abfrage beginnt. Die Reihenfolge der Feldwerte muss mit der Reihenfolge der order by-Klauseln der Abfrage übereinstimmen.
startAt(fieldValues)	Erstellt eine QueryStartAtConstraint , die den Ergebnissatz so ändert, dass er bei den bereitgestellten Feldern relativ zur Reihenfolge der Abfrage beginnt. Die Reihenfolge der Feldwerte muss mit der Reihenfolge der order by-Klauseln der Abfrage übereinstimmen.
Funktion(indexManager, ...)
deleteAllPersistentCacheIndexes(indexManager)	Entfernt alle persistenten Cache-Indizes. Bitte beachten Sie, dass diese Funktion auch von setIndexConfiguration() generierte Indizes löscht, was veraltet ist.
disablePersistentCacheIndexAutoCreation(indexManager)	Stoppt die automatische Erstellung persistenter Cache-Indizes für die lokale Abfrageausführung. Die durch den Aufruf von enablePersistentCacheIndexAutoCreation() erstellten Indizes sind weiterhin wirksam.
enablePersistentCacheIndexAutoCreation(indexManager)	Ermöglicht dem SDK, automatisch persistente Cache-Indizes für die lokale Abfrageausführung zu erstellen, wenn das SDK der Ansicht ist, dass Cache-Indizes zur Leistungsverbesserung beitragen können. Diese Funktion ist standardmäßig deaktiviert.
Funktion(links, ...)
aggregatFieldEqual(links, rechts)	Vergleicht zwei 'AggregateField „Instanzen für Gleichberechtigung.“
aggregatQuerySnapshotEqual(links, rechts)	Vergleicht zwei AggregateQuerySnapshot Instanzen auf Gleichheit. Zwei AggregateQuerySnapshot Instanzen gelten als „gleich“, wenn ihnen zugrunde liegende Abfragen mit gleichen Vergleichswerten und denselben Daten zugrunde liegen.
queryEqual(links, rechts)	Gibt „true“ zurück, wenn die bereitgestellten Abfragen auf dieselbe Sammlung verweisen und dieselben Einschränkungen anwenden.
refEqual(links, rechts)	Gibt „true“ zurück, wenn die bereitgestellten Referenzen gleich sind.
snapshotEqual(links, rechts)	Gibt true zurück, wenn die bereitgestellten Snapshots gleich sind.
Funktion(Limit, ...)
Grenze(Grenze)	Erstellt eine QueryLimitConstraint , die nur die ersten übereinstimmenden Dokumente zurückgibt.
limitToLast(limit)	Erstellt eine QueryLimitConstraint , die nur die letzten übereinstimmenden Dokumente zurückgibt. Sie müssen mindestens eine orderBy Klausel für limitToLast Abfragen angeben, andernfalls wird während der Ausführung eine Ausnahme ausgelöst.
Funktion(logLevel, ...)
setLogLevel(logLevel)	Legt die Ausführlichkeit von Cloud Firestore-Protokollen fest (Debug, Fehler oder Still).
Funktion(n, ...)
Inkrement(n)	Gibt einen speziellen Wert zurück, der mit setDoc() oder updateDoc() verwendet werden kann und den Server anweist, den aktuellen Wert des Felds um den angegebenen Wert zu erhöhen. Wenn entweder der Operand oder der aktuelle Feldwert Gleitkommagenauigkeit verwendet, folgt die gesamte Arithmetik der IEEE 754-Semantik. Wenn beide Werte Ganzzahlen sind, unterliegen auch Werte außerhalb des sicheren Zahlenbereichs von JavaScript ( Number.MIN_SAFE_INTEGER bis Number.MAX_SAFE_INTEGER ) einem Präzisionsverlust. Darüber hinaus sind alle Ganzzahloperationen nach der Verarbeitung durch das Firestore-Backend auf einen Wert zwischen -2^63 und 2^63-1 begrenzt. Wenn der aktuelle Feldwert nicht vom Typ number ist oder das Feld noch nicht vorhanden ist, setzt die Transformation das Feld auf den angegebenen Wert.
Funktion(Abfrage, ...)
getAggregateFromServer(query,aggregatSpec)	Berechnet die angegebenen Aggregationen über die Dokumente im Ergebnissatz der angegebenen Abfrage, ohne die Dokumente tatsächlich herunterzuladen. Die Verwendung dieser Funktion zum Durchführen von Aggregationen ist effizient, da nur die endgültigen Aggregationswerte und nicht die Daten der Dokumente heruntergeladen werden. Diese Funktion kann Aggregationen der Dokumente durchführen, wenn die Ergebnismenge zu groß ist, um sie vollständig herunterzuladen (Tausende von Dokumenten). Das vom Server empfangene Ergebnis wird unverändert und ohne Berücksichtigung des lokalen Status angezeigt. Das heißt, Dokumente im lokalen Cache werden nicht berücksichtigt, ebenso wenig werden lokale Änderungen berücksichtigt, die noch nicht mit dem Server synchronisiert sind. Zuvor heruntergeladene Ergebnisse, sofern vorhanden, werden nicht verwendet. Jeder Aufruf dieser Funktion erfordert zwangsläufig einen Roundtrip zum Server.
getCountFromServer(Abfrage)	Berechnet die Anzahl der Dokumente im Ergebnissatz der angegebenen Abfrage, ohne die Dokumente tatsächlich herunterzuladen. Die Verwendung dieser Funktion zum Zählen der Dokumente ist effizient, da nur die endgültige Zählung und nicht die Daten der Dokumente heruntergeladen werden. Diese Funktion kann die Dokumente zählen, wenn die Ergebnismenge zu groß ist, um sie vollständig herunterzuladen (Tausende von Dokumenten). Das vom Server empfangene Ergebnis wird unverändert und ohne Berücksichtigung des lokalen Status angezeigt. Das heißt, Dokumente im lokalen Cache werden nicht berücksichtigt, ebenso wenig werden lokale Änderungen berücksichtigt, die noch nicht mit dem Server synchronisiert sind. Zuvor heruntergeladene Ergebnisse, sofern vorhanden, werden nicht verwendet. Jeder Aufruf dieser Funktion erfordert zwangsläufig einen Roundtrip zum Server.
getDocs(Abfrage)	Führt die Abfrage aus und gibt die Ergebnisse als QuerySnapshot zurück. Hinweis: getDocs() versucht, wenn möglich, aktuelle Daten bereitzustellen, indem es auf Daten vom Server wartet. Es kann jedoch zwischengespeicherte Daten zurückgeben oder fehlschlagen, wenn Sie offline sind und der Server nicht erreichbar ist. Um dieses Verhalten festzulegen, rufen Sie getDocsFromCache() oder getDocsFromServer() auf. .
getDocsFromCache(Abfrage)	Führt die Abfrage aus und gibt die Ergebnisse als QuerySnapshot aus dem Cache zurück. Gibt einen leeren Ergebnissatz zurück, wenn derzeit keine mit der Abfrage übereinstimmenden Dokumente zwischengespeichert sind.
getDocsFromServer(Abfrage)	Führt die Abfrage aus und gibt die Ergebnisse als QuerySnapshot vom Server zurück. Gibt einen Fehler zurück, wenn das Netzwerk nicht verfügbar ist.
onSnapshot(Abfrage, Beobachter)	Fügt einen Listener für QuerySnapshot Ereignisse hinzu. Sie können entweder einzelne onNext und onError Rückrufe oder ein einzelnes Beobachterobjekt mit next und error Rückrufen übergeben. Der Listener kann abgebrochen werden, indem die Funktion aufgerufen wird, die beim Aufruf von onSnapshot zurückgegeben wird. HINWEIS: Obwohl ein onCompletion Rückruf bereitgestellt werden kann, wird dieser nie aufgerufen, da der Snapshot-Stream nie endet.
onSnapshot(Abfrage, Optionen, Beobachter)	Fügt einen Listener für QuerySnapshot Ereignisse hinzu. Sie können entweder einzelne onNext und onError Rückrufe oder ein einzelnes Beobachterobjekt mit next und error Rückrufen übergeben. Der Listener kann abgebrochen werden, indem die Funktion aufgerufen wird, die beim Aufruf von onSnapshot zurückgegeben wird. HINWEIS: Obwohl ein onCompletion Rückruf bereitgestellt werden kann, wird dieser nie aufgerufen, da der Snapshot-Stream nie endet.
onSnapshot(query, onNext, onError, onCompletion)	Fügt einen Listener für QuerySnapshot Ereignisse hinzu. Sie können entweder einzelne onNext und onError Rückrufe oder ein einzelnes Beobachterobjekt mit next und error Rückrufen übergeben. Der Listener kann abgebrochen werden, indem die Funktion aufgerufen wird, die beim Aufruf von onSnapshot zurückgegeben wird. HINWEIS: Obwohl ein onCompletion Rückruf bereitgestellt werden kann, wird dieser nie aufgerufen, da der Snapshot-Stream nie endet.
onSnapshot(Abfrage, Optionen, onNext, onError, onCompletion)	Fügt einen Listener für QuerySnapshot Ereignisse hinzu. Sie können entweder einzelne onNext und onError Rückrufe oder ein einzelnes Beobachterobjekt mit next und error Rückrufen übergeben. Der Listener kann abgebrochen werden, indem die Funktion aufgerufen wird, die beim Aufruf von onSnapshot zurückgegeben wird. HINWEIS: Obwohl ein onCompletion Rückruf bereitgestellt werden kann, wird dieser nie aufgerufen, da der Snapshot-Stream niemals endet.
Abfrage(Abfrage, CompositeFilter, AbfrageConstraints)	Erstellt eine neue unveränderliche Instanz von Query , die um zusätzliche Abfrageeinschränkungen erweitert wird.
query(query, queryConstraints)	Erstellt eine neue unveränderliche Instanz von Query , die um zusätzliche Abfrageeinschränkungen erweitert wird.
Funktion(queryConstraints, ...)
und(queryConstraints)	Erstellt eine neue QueryCompositeFilterConstraint , die eine Verbindung der angegebenen Filtereinschränkungen ist. Ein Konjunktionsfilter schließt ein Dokument ein, wenn es alle angegebenen Filter erfüllt.
oder(queryConstraints)	Erstellt eine neue QueryCompositeFilterConstraint , die eine Disjunktion der angegebenen Filtereinschränkungen ist. Ein Disjunktionsfilter schließt ein Dokument ein, wenn es einen der angegebenen Filter erfüllt.
Funktion(Referenz, ...)
addDoc(Referenz, Daten)	Fügen Sie mit den angegebenen Daten ein neues Dokument zur angegebenen CollectionReference hinzu und weisen Sie ihm automatisch eine Dokument-ID zu.
Sammlung (Referenz, Pfad, Pfadsegmente)	Ruft eine CollectionReference Instanz ab, die auf eine untergeordnete reference im angegebenen relativen Pfad verweist.
Sammlung (Referenz, Pfad, Pfadsegmente)	Ruft eine CollectionReference Instanz ab, die auf eine untergeordnete reference im angegebenen relativen Pfad verweist.
deleteDoc(Referenz)	Löscht das Dokument, auf das durch die angegebene DocumentReference verwiesen wird.
doc(Referenz, Pfad, Pfadsegmente)	Ruft eine DocumentReference Instanz ab, die auf ein Dokument innerhalb der reference am angegebenen relativen Pfad verweist. Wenn kein Pfad angegeben ist, wird eine automatisch generierte eindeutige ID für die zurückgegebene DocumentReference verwendet.
doc(Referenz, Pfad, Pfadsegmente)	Ruft eine DocumentReference Instanz ab, die auf ein Dokument innerhalb der reference am angegebenen relativen Pfad verweist.
getDoc(Referenz)	Liest das Dokument, auf das sich diese DocumentReference bezieht. Hinweis: getDoc() versucht, wenn möglich, aktuelle Daten bereitzustellen, indem es auf Daten vom Server wartet. Es kann jedoch zwischengespeicherte Daten zurückgeben oder fehlschlagen, wenn Sie offline sind und der Server nicht erreichbar ist. Um dieses Verhalten festzulegen, rufen Sie getDocFromCache() oder getDocFromServer() auf. .
getDocFromCache(Referenz)	Liest das Dokument, auf das sich diese DocumentReference bezieht, aus dem Cache. Gibt einen Fehler zurück, wenn das Dokument derzeit nicht zwischengespeichert ist.
getDocFromServer(Referenz)	Liest das Dokument, auf das sich diese DocumentReference bezieht, vom Server. Gibt einen Fehler zurück, wenn das Netzwerk nicht verfügbar ist.
onSnapshot(Referenz, Beobachter)	Fügt einen Listener für DocumentSnapshot Ereignisse hinzu. Sie können entweder einzelne onNext und onError Rückrufe oder ein einzelnes Beobachterobjekt mit next und error Rückrufen übergeben. HINWEIS: Obwohl ein onCompletion Rückruf bereitgestellt werden kann, wird dieser nie aufgerufen, da der Snapshot-Stream niemals endet.
onSnapshot(Referenz, Optionen, Beobachter)	Fügt einen Listener für DocumentSnapshot Ereignisse hinzu. Sie können entweder einzelne onNext und onError Rückrufe oder ein einzelnes Beobachterobjekt mit next und error Rückrufen übergeben. HINWEIS: Obwohl ein onCompletion Rückruf bereitgestellt werden kann, wird dieser nie aufgerufen, da der Snapshot-Stream niemals endet.
onSnapshot(Referenz, onNext, onError, onCompletion)	Fügt einen Listener für DocumentSnapshot Ereignisse hinzu. Sie können entweder einzelne onNext und onError Rückrufe oder ein einzelnes Beobachterobjekt mit next und error Rückrufen übergeben. HINWEIS: Obwohl ein onCompletion Rückruf bereitgestellt werden kann, wird dieser nie aufgerufen, da der Snapshot-Stream niemals endet.
onSnapshot(Referenz, Optionen, onNext, onError, onCompletion)	Fügt einen Listener für DocumentSnapshot Ereignisse hinzu. Sie können entweder einzelne onNext und onError Rückrufe oder ein einzelnes Beobachterobjekt mit next und error Rückrufen übergeben. HINWEIS: Obwohl ein onCompletion Rückruf bereitgestellt werden kann, wird dieser nie aufgerufen, da der Snapshot-Stream niemals endet.
setDoc(Referenz, Daten)	Schreibt in das Dokument, auf das diese DocumentReference verweist. Wenn das Dokument noch nicht existiert, wird es erstellt.
setDoc(Referenz, Daten, Optionen)	Schreibt in das Dokument, auf das die angegebene DocumentReference verweist. Wenn das Dokument noch nicht existiert, wird es erstellt. Wenn Sie merge oder mergeFields bereitstellen, können die bereitgestellten Daten in ein vorhandenes Dokument eingefügt werden.
updateDoc(Referenz, Daten)	Aktualisiert Felder im Dokument, auf das durch die angegebene DocumentReference verwiesen wird. Die Aktualisierung schlägt fehl, wenn sie auf ein nicht vorhandenes Dokument angewendet wird.
updateDoc(Referenz, Feld, Wert, moreFieldsAndValues)	Aktualisiert Felder im Dokument, auf das die angegebene DocumentReference verweist. Die Aktualisierung schlägt fehl, wenn sie auf ein Dokument angewendet wird, das nicht vorhanden ist. Verschachtelte Felder können durch die Bereitstellung von durch Punkte getrennten Feldpfadzeichenfolgen oder durch die Bereitstellung FieldPath Objekten aktualisiert werden.
Funktion(Einstellungen, ...)
MemoryLocalCache(Einstellungen)	Erstellt eine Instanz von MemoryLocalCache . Die Instanz kann auf FirestoreSettings.cache gesetzt werden, um dem SDK mitzuteilen, welche Cache-Ebene verwendet werden soll.
MemoryLruGarbageCollector(Einstellungen)	Erstellt eine Instanz von MemoryLruGarbageCollector . Im Rahmen des Einstellparameters kann eine Zielgröße angegeben werden. Der Collector beginnt mit dem Löschen von Dokumenten, sobald die Cachegröße die angegebene Größe überschreitet. Die Standard-Cache-Größe beträgt 40 MB (40 * 1024 * 1024 Byte).
persistentLocalCache(Einstellungen)	Erstellt eine Instanz von PersistentLocalCache . Die Instanz kann auf FirestoreSettings.cache gesetzt werden, um dem SDK mitzuteilen, welche Cache-Ebene verwendet werden soll. Persistenter Cache kann in einer Node.js-Umgebung nicht verwendet werden.
persistentSingleTabManager(Einstellungen)	Erstellt eine Instanz von PersistentSingleTabManager .
Funktion(Schnappschuss, ...)
endAt(Snapshot)	Erstellt eine QueryEndAtConstraint , die den Ergebnissatz so ändert, dass er beim bereitgestellten Dokument (einschließlich) endet. Die Endposition ist relativ zur Reihenfolge der Abfrage. Das Dokument muss alle im orderBy der Abfrage bereitgestellten Felder enthalten.
endBefore(Schnappschuss)	Erstellt eine QueryEndAtConstraint , die die Ergebnismenge so ändert, dass sie vor dem bereitgestellten Dokument endet (exklusiv). Die Endposition ist relativ zur Reihenfolge der Abfrage. Das Dokument muss alle im orderBy der Abfrage bereitgestellten Felder enthalten.
startAfter(Schnappschuss)	Erstellt eine QueryStartAtConstraint , die den Ergebnissatz so ändert, dass er nach dem bereitgestellten Dokument beginnt (exklusiv). Die Startposition ist relativ zur Reihenfolge der Abfrage. Das Dokument muss alle im orderBy der Abfrage bereitgestellten Felder enthalten.
startAt(snapshot)	Erstellt eine QueryStartAtConstraint , die den Ergebnissatz so ändert, dass er beim bereitgestellten Dokument (einschließlich) beginnt. Die Startposition ist relativ zur Reihenfolge der Abfrage. Das Dokument muss alle im orderBy dieser Abfrage bereitgestellten Felder enthalten.

Klassen

Klasse	Beschreibung
AggregateField	Stellt eine Aggregation dar, die von Firestore durchgeführt werden kann.
AggregateQuerySnapshot	Die Ergebnisse der Ausführung einer Aggregationsabfrage.
Bytes	Ein unveränderliches Objekt, das ein Array von Bytes darstellt.
CollectionReference	Ein CollectionReference Objekt kann zum Hinzufügen von Dokumenten, zum Abrufen von Dokumentverweisen und zum Abfragen von Dokumenten (mit query()) verwendet werden. ).
Dokumentverweis	Eine DocumentReference verweist auf einen Dokumentspeicherort in einer Firestore-Datenbank und kann zum Schreiben, Lesen oder Abhören des Speicherorts verwendet werden. Das Dokument am angegebenen Speicherort kann vorhanden sein oder auch nicht.
DocumentSnapshot	Ein DocumentSnapshot enthält Daten, die aus einem Dokument in Ihrer Firestore-Datenbank gelesen wurden. Die Daten können mit .data() oder .get(<field>) extrahiert werden, um ein bestimmtes Feld zu erhalten. Bei einem DocumentSnapshot , der auf ein nicht vorhandenes Dokument verweist, gibt jeder Datenzugriff „undefiniert“ zurück. Sie können die Methode exists() verwenden, um die Existenz eines Dokuments explizit zu überprüfen.
FieldPath	Ein FieldPath bezieht sich auf ein Feld in einem Dokument. Der Pfad kann aus einem einzelnen Feldnamen (der sich auf ein Feld der obersten Ebene im Dokument bezieht) oder aus einer Liste von Feldnamen (die sich auf ein verschachteltes Feld im Dokument bezieht) bestehen. Erstellen Sie einen FieldPath , indem Sie Feldnamen angeben. Wenn mehr als ein Feldname angegeben wird, verweist der Pfad auf ein verschachteltes Feld in einem Dokument.
Feldwert	Sentinel-Werte, die beim Schreiben von Dokumentfeldern mit set() oder update() verwendet werden können.
Feuerladen	Die Cloud Firestore-Dienstschnittstelle. Rufen Sie diesen Konstruktor nicht direkt auf. Verwenden Sie stattdessen getFirestore() .
FirestoreError	Ein von einem Firestore-Vorgang zurückgegebener Fehler.
GeoPoint	Ein unveränderliches Objekt, das einen geografischen Standort in Firestore darstellt. Der Standort wird als Breiten-/Längengradpaar dargestellt. Breitengrade liegen im Bereich von [-90, 90]. Längengrade liegen im Bereich von [-180, 180].
LoadBundleTask	Stellt die Aufgabe dar, ein Firestore-Bundle zu laden. Es zeigt den Fortschritt des Bundle-Ladens sowie den Abschluss von Aufgaben und Fehlerereignisse an. Die API ist mit Promise<LoadBundleTaskProgress> kompatibel.
PersistentCacheIndexManager	Ein PersistentCacheIndexManager zum Konfigurieren persistenter Cache-Indizes, die für die lokale Abfrageausführung verwendet werden. Rufen Sie zur Verwendung getPersistentCacheIndexManager() auf, um eine Instanz abzurufen.
Abfrage	Eine Query bezieht sich auf eine Abfrage, die Sie lesen oder anhören können. Sie können auch verfeinerte Query erstellen, indem Sie Filter und Sortierungen hinzufügen.
QueryCompositeFilterConstraint	Eine QueryCompositeFilterConstraint wird verwendet, um den Satz von Dokumenten einzugrenzen, die von einer Firestore-Abfrage zurückgegeben werden, indem das logische ODER oder UND mehrerer QueryFieldFilterConstraints ausgeführt wird s oder QueryCompositeFilterConstraint S. QueryCompositeFilterConstraint s werden durch Aufrufen von or() oder and() erstellt und können dann an query() übergeben werden, um eine neue Abfrageinstanz zu erstellen, die auch QueryCompositeFilterConstraint enthält.
Abfrageeinschränkung	Eine QueryConstraint wird verwendet, um den Satz von Dokumenten einzugrenzen, die von einer Firestore-Abfrage zurückgegeben werden. QueryConstraint s werden durch Aufrufen von where() erstellt , Sortieren nach() , anfangen bei() , startAfter() , endBefore() , endAt() , Grenze() , limitToLast() und kann dann an query() übergeben werden, um eine neue Abfrageinstanz zu erstellen, die auch diese QueryConstraint enthält.
QueryDocumentSnapshot	Ein QueryDocumentSnapshot enthält Daten, die im Rahmen einer Abfrage aus einem Dokument in Ihrer Firestore-Datenbank gelesen wurden. Die Existenz des Dokuments ist garantiert und seine Daten können mit .data() oder .get(<field>) extrahiert werden, um ein bestimmtes Feld zu erhalten. Ein QueryDocumentSnapshot bietet die gleiche API-Oberfläche wie ein DocumentSnapshot . Da Abfrageergebnisse nur vorhandene Dokumente enthalten, ist die Eigenschaft „ exists “ immer wahr und data() gibt niemals „undefiniert“ zurück.
QueryEndAtConstraint	Ein QueryEndAtConstraint wird verwendet, um Dokumente vom Ende eines Ergebnissatzes auszuschließen, der von einer Firestore-Abfrage zurückgegeben wird. QueryEndAtConstraint s werden durch Aufrufen von endAt() oder endBefore() erstellt und können dann an query() übergeben werden, um eine neue Abfrageinstanz zu erstellen, die auch diesen QueryEndAtConstraint enthält.
QueryFieldFilterConstraint	Eine QueryFieldFilterConstraint wird verwendet, um die Menge der von einer Firestore-Abfrage zurückgegebenen Dokumente einzugrenzen, indem nach einem oder mehreren Dokumentfeldern gefiltert wird. QueryFieldFilterConstraint s werden durch den Aufruf von where() erstellt und können dann an query() übergeben werden, um eine neue Abfrageinstanz zu erstellen, die auch diesen QueryFieldFilterConstraint enthält.
QueryLimitConstraint	Ein QueryLimitConstraint wird verwendet, um die Anzahl der von einer Firestore-Abfrage zurückgegebenen Dokumente zu begrenzen. QueryLimitConstraint s werden durch Aufrufen von limit() oder limitToLast() erstellt und können dann an query() übergeben werden, um eine neue Abfrageinstanz zu erstellen, die auch diesen QueryLimitConstraint enthält.
QueryOrderByConstraint	Ein QueryOrderByConstraint wird verwendet, um den Satz von Dokumenten zu sortieren, die von einer Firestore-Abfrage zurückgegeben werden. QueryOrderByConstraint s werden durch Aufrufen von orderBy() erstellt und können dann an query() übergeben werden, um eine neue Abfrageinstanz zu erstellen, die auch diesen QueryOrderByConstraint enthält. Hinweis: Dokumente, die das Feld "OrderBy" nicht enthalten, sind im Abfrageergebnis nicht vorhanden.
Querysnapshot	Ein QuerySnapshot enthält Null- oder mehr DocumentSnapshot -Objekte, die die Ergebnisse einer Abfrage darstellen. Die Dokumente können als Array über die docs -Eigenschaft zugegriffen oder unter Verwendung der forEach -Methode aufgezählt werden. Die Anzahl der Dokumente kann über die empty und size bestimmt werden.
Abfragebedarf	Eine QueryStartAtConstraint wird verwendet, um Dokumente vom Beginn eines von einer Firestore -Abfrage zurückgegebenen Ergebnisses auszuschließen. QueryStartAtConstraint S werden erstellt, indem startat () oder startAtefter () aufgerufen wird und dann an Query () übergeben werden kann, um eine neue Abfrageinstanz zu erstellen, die auch diese QueryStartAtConstraint enthält.
Snapshotmetadaten	Metadaten über einen Schnappschuss, der den Zustand des Schnappschusses beschreibt.
Zeitstempel	Ein Timestamp stellt einen Zeitpunkt dar, der unabhängig von Zeitzone oder Kalender ist, die als Sekunden und Brüche von Sekunden bei der Auflösung von Nanosekunden in der UTC -Epoche -Zeit dargestellt wird. Es wird mit dem prolptischen gregorianischen Kalender kodiert, der den gregorianischen Kalender bis zum ersten Jahr erweitert. Es ist codiert, vorausgesetzt, alle Minuten sind 60 Sekunden lang, dh Schleppsekunden sind "verschmiert", so dass für die Interpretation kein zweiter Tisch benötigt wird. Die Reichweite ist von 0001-01-01T00: 00: 00Z bis 9999-12-31T23: 59: 59,999999999z. Beispiele und weitere Spezifikationen finden Sie in der Zeitstempeldefinition .
Transaktion	Ein Verweis auf eine Transaktion. Das an die updateFunction einer Transaktion übergebene Transaction bietet die Methoden zum Lesen und Schreiben von Daten im Transaktionskontext. Siehe Runtransaction () .
WriteBatch	Eine Schreibbatch, die zum Ausführen mehrerer Schreibvorgänge als einzelne Atomeinheit verwendet wird. Ein WriteBatch -Objekt kann erfasst werden, indem WriteBatch () aufgerufen wird . Es bietet Methoden zum Hinzufügen von Schreibvorgängen zum Write -Stapel. Keiner der Schreibvorgänge wird verpflichtet (oder lokal sichtbar), bis WriteBatch.commit () aufgerufen wird.

Schnittstellen

Schnittstelle	Beschreibung
AggregateSpec	Gibt eine Reihe von Aggregationen und ihre Aliase an.
DocumentChange	Ein DocumentChange stellt eine Änderung der Dokumente dar, die einer Abfrage entsprechen. Es enthält das betroffene Dokument und die Art der Änderung, die aufgetreten ist.
DocumentData	Dokumentdaten (zur Verwendung mit setDoc () ) besteht aus Feldern, die den Werten zugeordnet sind.
Experimentallongpollingoptionen	Optionen, die den zugrunde liegenden Netzwerktransport (WebChannel) des SDK beim Langstrecken-Verfahren konfigurieren. Hinweis: Diese Schnittstelle ist "experimentell" und ändert sich. Siehe FirestoreSettings.experimentalAutoDetectLongPolling , FirestoreSettings.experimentalForceLongPolling und FirestoreSettings.experimentalLongPollingOptions .
FireToredataconverter	Konverter verwendet von withConverter() , um Benutzerobjekte vom Typ AppModelType in Firestore -Daten vom Typ DbModelType zu verwandeln. Mithilfe des Konverters können Sie bei der Speicherung und Abrufen von Objekten von Firestore generische Argumente angeben. In diesem Zusammenhang ist ein "AppModel" eine Klasse, die in einer Anwendung verwendet wird, um verwandte Informationen und Funktionen zusammenzupacken. Eine solche Klasse könnte beispielsweise Eigenschaften mit komplexen, verschachtelten Datentypen, Eigenschaften für die Memoisierung, Eigenschaften von Typen haben, die nicht von Firestore (wie symbol und bigint ) unterstützt werden, und Helferfunktionen, die zusammengesetzte Operationen ausführen. Solche Klassen sind nicht geeignet und/oder möglich, um in eine Firestore -Datenbank zu speichern. Stattdessen müssen Fälle solcher Klassen in "einfache alte JavaScript -Objekte" (Pojos) mit ausschließlich primitiven Eigenschaften umgewandelt werden, die möglicherweise in anderen Pojos oder Arrays von Pojos verschachtelt werden. In diesem Zusammenhang wird dieser Typ als "dbmodel" bezeichnet und wäre ein Objekt, das für das Bestehen in Firestore geeignet ist. Für den Einfachheit halber können Anwendungen FirestoreDataConverter implementieren und den Konverter mit Firestore -Objekten wie DocumentReference oder Query registrieren, um AppModel automatisch in DbModel beim Speichern in Firestore umzuwandeln und DbModel beim Absenken von Firestore in AppModel zu konvertieren.
Firestoresettings	Gibt benutzerdefinierte Konfigurationen für Ihre Cloud Firestore -Instanz an. Sie müssen diese festlegen, bevor Sie andere Methoden aufrufen.
Index	(Beta) Die SDK -Definition eines Firestore -Index.
Indexkonfiguration	(Beta) Eine Liste von Firestore -Indizes, um die lokale Abfrageausführung zu beschleunigen. Eine Beschreibung des Formats der Indexdefinition finden Sie in JSON -Format .
Indexfield	(Beta) Ein einzelnes Feldelement in einer Indexkonfiguration.
Lastbundletaskprogress	Repräsentiert ein Fortschritts -Update oder einen endgültigen Zustand aus dem Laden von Bundles.
MemoryCachesettings	Ein Einstellungsobjekt zum Konfigurieren einer MemoryLocalCache -Instanz.
MemoryAgergarbagleCollector	Ein Müllsammler löscht Dokumente, wenn er nicht Teil von aktiven Abfragen ist, und hat keine lokalen Mutationen an sie. Dieser Kollektor versucht, die niedrigsten Speicher Fußabdrücke aus der SDK zu gewährleisten, da Dokumente nicht für Offline -Abfragen oder direkte Abfragen zum Cache zwischenstrichen werden. Verwenden Sie die Fabrikfunktion, um eine Instanz dieses Sammlers zu erstellen.
MemoryLocalCache	Bietet dem SDK einen Memory-Cache. Dies ist der Standard -Cache, es sei denn, es wird etwas anderes ausdrücklich konfiguriert. Erstellen Sie eine Instanz mit der Fabrikfunktion und setzen Sie die Instanz auf FirestoreSettings.cache und rufen Sie initializeFirestore mit dem Einstellungsobjekt auf.
MEMETSLRUGARBAGECOLLECTOR	Ein Müllsammler löscht Dokumente in mehreren Chargen am wenigsten zu verwendeten. Dieser Kollektor ist mit einer Zielgröße konfiguriert und führt nur die Sammlung durch, wenn die zwischengespeicherten Dokumente die Zielgröße überschreiten. Es wird vermieden, dass das Abfragen von Backend, das für dieselbe Abfrage oder Dokument wiederholt wurde, auf das Risiko einer größeren Speicherpflichtzruors. Verwenden Sie die Fabrikfunktion, um eine Instanz dieses Sammlers zu erstellen.
Persistencesettings	Einstellungen, die übergeben werden können, um die Firestore enableIndexedDbPersistence() zu konfigurieren. Persistenz kann in einer node.js -Umgebung nicht verwendet werden.
Persistentcachesettings	Ein Einstellungsobjekt, um eine PersistentLocalCache -Instanz zu konfigurieren. Persistierender Cache kann in einer node.js -Umgebung nicht verwendet werden.
PersistentLocalcache	Bietet einen anhaltenden Cache, der von IndexedDB für die SDK unterstützt wird. Erstellen Sie eine Instanz mit der Fabrikfunktion und setzen Sie die Instanz auf FirestoreSettings.cache und rufen Sie initializeFirestore mit dem Einstellungsobjekt auf.
Persistentmultipletabmanager	Ein Registerkartenmanager, der mehrere Registerkarten unterstützt. SDK synchronisieren Abfragen und Mutationen, die auf allen Registerkarten mit dem SDK durchgeführt wurden.
PersistentSingletabmanager	Ein Registerkarte Manager, der nur eine Registerkarte unterstützt, wird keine Synchronisation über Registerkarten durchgeführt.
PersistentSingletabmanagersettings	Geben Sie ein, um eine PersistentSingleTabManager -Instanz zu konfigurieren.
Schnappschusslistenoptionen	Ein Optionsobjekt, das an ONSNAPSHOT () und querysnapshot.docchanges () übergeben werden kann, um zu steuern, welche Arten von Änderungen in den Ergebnissatz einbezogen werden sollen.
Schnappschuss	Optionen, die konfigurieren, wie Daten aus einem DocumentSnapshot abgerufen werden (z. B. das gewünschte Verhalten für Server -Zeitstempel, die noch nicht auf ihren Endwert festgelegt wurden).
Transaktionoptionen	Optionen zum Anpassen des Transaktionsverhaltens.
Abbestellen	Eine Funktion, die von onSnapshot() zurückgegeben wird, die den Hörer beim Aufrufen entfernt.

Variablen

Variable	Beschreibung
Cache_size_unlimited	Konstant verwendet, um anzuzeigen, dass die LRU -Müllsammlung deaktiviert werden sollte. Legen Sie diesen Wert als cacheSizeBytes auf den Einstellungen an, die an die Firestore -Instanz übergeben wurden.

Geben Sie Aliase ein

Typ Alias	Beschreibung
Addprefixtokeys	Gibt eine neue Karte zurück, auf der jeder Schlüssel mit dem an einen Punkt angehängten äußeren Schlüssel vorangestellt ist.
AggregateFieldType	Die Vereinigung aller AggregateField -Typen, die von Firestore unterstützt werden.
Aggregatespecdata	Ein Typ, dessen Schlüssel aus einem AggregateSpec entnommen wird und dessen Werte das Ergebnis der Aggregation sind, die vom entsprechenden AggregateField aus der AggregateSpec durchgeführt wird.
Aggregatetyp	Gewerkschaftstyp, der den zu ausgeführten Gesamttyp darstellt.
Childupdatefields	Helfer zur Berechnung der verschachtelten Felder für einen bestimmten Typ T1. Dies ist erforderlich, um Gewerkschaftstypen wie undefined | {...} zu verteilen undefined | {...} (passiert für optionale Requisiten) oder {a: A} | {b: B} . In diesem Anwendungsfall wird V verwendet, um die Gewerkschaftstypen von T[K] Record , da T[K] als Expression bewertet und nicht verteilt wird. Siehe https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-Conditional-types
DocumentChangetype	Der Typ eines DocumentChange kann "hinzugefügt", "entfernt" oder "modifiziert" hinzugefügt werden.
FirestoreErrorCode	Die Reihe von Firestore -Statuscodes. Die Codes sind gleich an den von GRPC hier ausgesetzt Mögliche Werte: - 'Storniert': Die Operation wurde storniert (normalerweise vom Anrufer). - 'Unbekannt': Unbekannter Fehler oder Fehler aus einer anderen Fehlerdomäne. - 'ungültiges Argument': Client hat ein ungültiges Argument angegeben. Beachten Sie, dass dies von "fehlgeschlagener Präkondition" unterscheidet. 'Invalid-Argument' gibt Argumente an, die unabhängig vom Zustand des Systems problematisch sind (z. B. ein ungültiger Feldname). - 'Deadline-Expreate': Frist, die vor Abschluss des Betriebs abgelaufen ist. Für Operationen, die den Status des Systems ändern, kann dieser Fehler auch dann zurückgegeben werden, wenn der Betrieb erfolgreich abgeschlossen ist. Zum Beispiel hätte eine erfolgreiche Antwort eines Servers lange genug verzögert werden können, damit die Frist abgelaufen ist. - 'nicht fundiert': Einige angeforderte Dokument wurden nicht gefunden. - 'Bothone-Exists': Ein Dokument, das wir bereits erstellen versuchten, gibt es bereits. . . - 'fehlgeschlagene Vorkondition': Der Betrieb wurde abgelehnt, da sich das System nicht in einem Zustand befindet, der für die Ausführung des Betriebs erforderlich ist. - 'abgebrochen': Die Operation wurde abgebrochen, typischerweise aufgrund eines Problems mit Parallelität wie Transaktionsabbruch usw.- 'Out-of-A-of-Range': Die Operation wurde versucht, die gültige Reichweite zu überschreiten. - 'Unimplemented': Der Betrieb wird nicht implementiert oder nicht unterstützt/aktiviert. - 'Internal': interne Fehler. Bedeutet, dass einige Invarianten, die nach dem zugrunde liegenden System erwartet werden, gebrochen wurde. Wenn Sie einen dieser Fehler sehen, ist etwas sehr kaputt. - 'nicht verfügbar': Der Dienst ist derzeit nicht verfügbar. Dies ist höchstwahrscheinlich eine vorübergehende Bedingung und kann durch Wiederieren mit einem Backoff korrigiert werden. - 'Data-Loss': Nicht wiedervertragbarer Datenverlust oder Korruption. - 'nicht authentifiziert': Die Anfrage hat keine gültigen Authentifizierungsanmeldeinformationen für den Vorgang.
Firestorelocalcache	Gewerkschaftstyp aus allen unterstützten SDK -Cache -Schicht.
HavenSource	Beschreiben Sie die Quelle, die eine Abfrage hört. Legen Sie auf default ein, um sowohl Cache- als auch Serveränderungen anzuhören. Setzen Sie auf cache , um nur Änderungen im Cache anzuhören.
MEHREGEGELN	Gewerkschaftstyp aus allen Unterstützung von Gabage -Sammlern für Speicher lokaler Cache.
NestedUpdateFields	Finden Sie für jedes Feld (zB 'Bar') alle verschachtelten Schlüssel (z. B. { 'bar.baz': t1, 'bar.qux': t2 } ). Schneiden Sie sie zusammen, um eine einzelne Karte mit allen möglichen Schlüssel zu erstellen, die alle als optional gekennzeichnet sind
OrderByDirection	Die Richtung einer OrderBy () -Klausel wird als "Desc" oder "ASC" (absteigend oder aufsteigend) angegeben.
PartiellWithfieldValue	Ähnlich wie bei Partial<T> , können verschachtelte Felder jedoch weggelassen werden und Feldvalues ​​als Eigenschaftswerte übergeben werden.
PersistentTabmanager	Eine Vereinigung aller verfügbaren TAB -Manager.
Primitive	Primitive Typen.
QueryConstraintType	Beschreibt die verschiedenen Abfragenbeschränkungen in diesem SDK.
QueryFilterconstraint	QueryFilterConstraint ist ein Helfer -Unionstyp, der QueryfieldFilterConstraint und QueryCompositeFilterConstraint darstellt .
QuerynonFilterconstraint	QueryNonFilterConstraint ist ein Helfer -Gewerkschaftstyp, der Abfragen darstellt, die zur Begrenzung oder Bestellung der Dokumente verwendet werden, die jedoch nicht explizit in einem Dokumentfeld filtern. QueryNonFilterConstraint S werden durch Aufrufen von OrderBy () erstellt , anfangen bei() , starten nach () , Endbefore () , Endat () , limit () oder limittolast () und kann dann an query () übergeben werden, um eine neue Abfrageinstanz zu erstellen, die auch die QueryConstraint enthält.
Setoptionen	Ein Optionsobjekt, das das Verhalten von setDoc () konfiguriert und Anrufe. Diese Anrufe können so konfiguriert werden, dass sie detaillierte Zusammenführungen durchführen, anstatt die Zieldokumente in ihrer Gesamtheit zu überschreiben, indem SetOptions mit merge: true bereitgestellt werden.
TaskState	Repräsentiert den Zustand der Bündelbeladungsaufgaben. Sowohl "Fehler" als auch "Erfolg" sind ein sinkender Zustand: Die Aufgabe abbricht oder vervollständigt und es wird keine Aktualisierungen mehr geben, nachdem sie gemeldet wurden.
UnionTointersection	Bei einem Gewerkschaftstyp U = T1 | T2 | ... , gibt einen überarbeiteten Typ zurück (T1 & T2 & ...) . Verwendet verteilte bedingte Typen und Inferenz von bedingten Typen. Dies funktioniert, da mehrere Kandidaten für die gleiche Typvariable in kontravarianten Positionen dazu führen, dass ein Schnitttyp abgeleitet wird. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-t-intinction -Typ
Daten aktualisieren	Daten aktualisieren (zur Verwendung mit updateCoc () ) Das besteht aus Feldpfaden (z. B. 'foo' oder 'foo.baz'), die den Werten zugeordnet sind. Felder, die Punkte enthalten, verweisen auf verschachtelte Felder im Dokument. Feldwerte können als Eigenschaftswerte übergeben werden.
Wo filterop	Filterbedingungen in einer WO () -Klausel werden unter Verwendung der Zeichenfolgen '& lt;', '& lt; =', '==', '! =', '& Gt; =', '& gt;', 'Array-Contains' angegeben. , 'in', 'Array-Contains-Any' und 'Not-in'.
WithfieldValue	Ermöglicht den Feldvalues ​​als Eigenschaftswert, gleichzeitig die Art der Art zu erhalten.

Funktion (App, ...)

GetFirestore (App)

Gibt die vorhandene Standard -Firestore -Instanz zurück, die mit dem bereitgestellten FirebaseApp verbunden ist . Wenn keine Instanz besteht, initialisiert eine neue Instanz mit Standardeinstellungen.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
App	FirebaseApp	Die FirebaseApp -Instanz, mit der die zurückgegebene Firestore -Instanz verbunden ist.

Kehrt zurück:

Feuerladen

Die Standard -Firestore -Instanz der bereitgestellten App.

GetFirestore (App, DataBaseId)

Diese API wird als Vorschau für Entwickler bereitgestellt und kann sich basierend auf dem von uns erhaltenen Feedback ändern. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt die vorhandene benannte Firestore -Instanz zurück, die mit dem bereitgestellten FirebaseApp verbunden ist . Wenn keine Instanz besteht, initialisiert eine neue Instanz mit Standardeinstellungen.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
App	FirebaseApp	Die FirebaseApp -Instanz, mit der die zurückgegebene Firestore -Instanz verbunden ist.
Datenbasis	Zeichenfolge	Der Name der Datenbank.

Kehrt zurück:

Feuerladen

Die benannte Firestore -Instanz der bereitgestellten App.

initializeFirestore (App, Einstellungen, DataBaseId)

Initialisiert eine neue Instanz von Firestore mit den bereitgestellten Einstellungen. Kann nur vor einer anderen Funktion aufgerufen werden, einschließlich GetFirestore () . Wenn die benutzerdefinierten Einstellungen leer sind, entspricht diese Funktion dem Aufrufen von GetFirestore () .

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
App	FirebaseApp	Der FirebaseApp , mit dem die Firestore -Instanz verbunden ist.
Einstellungen	Firestoresettings	Ein Einstellungsobjekt zum Konfigurieren der Firestore -Instanz.
Datenbasis	Zeichenfolge	Der Name der Datenbank.

Kehrt zurück:

Feuerladen

Eine neu initialisierte Firestore -Instanz.

Funktion (Firestore, ...)

ClearIndexedDbPersistence (Firestore)

Löscht den anhaltenden Speicher. Dies schließt anhängige Schreibvorgänge und zwischengespeicherte Dokumente ein.

Muss aufgerufen werden, während die Firestore -Instanz nicht gestartet wird (nachdem die App beendet wurde oder wenn die App zum ersten Mal initialisiert wird). Beim Start muss diese Funktion vor anderen Funktionen aufgerufen werden (außer initializeFirestore () oder getfirestore () )). Wenn die Firestore- Instanz noch ausgeführt wird, wird das Versprechen mit dem Fehlercode der failed-precondition abgelehnt .

HINWEIS: clearIndexedDbPersistence() soll in erster Linie helfen, zuverlässige Tests zu schreiben, die Cloud Firestore verwenden. Es verwendet einen effizienten Mechanismus zum Ablegen vorhandener Daten, versucht jedoch nicht, sicher zu überschreiben oder auf andere Weise zwischengespeicherte Daten zu überschreiben. Bei Anwendungen, die für die Offenlegung von zwischengespeicherten Daten zwischen den Benutzersitzungen empfindlich sind, empfehlen wir dringend, die Persistenz überhaupt nicht zu aktivieren.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen	Die Firestore -Instanz, um die Beharrlichkeit zu klären.

Kehrt zurück:

Versprechen <void>

Ein Promise , das beigelöst wird, wenn der anhaltende Speicher gelöscht wird. Andernfalls wird dem Versprechen einen Fehler abgelehnt.

Sammlung (Firestore, Pfad, PathSegmente)

Erhält eine CollectionReference , die sich auf die Sammlung auf dem angegebenen Absolute -Pfad bezieht.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen	Ein Verweis auf die Firestore .
Weg	Zeichenfolge	Ein mit Slash getrennter Weg zu einer Sammlung.
Pfadsegmente	String []	Zusätzliche Pfadsegmente, die sich relativ zum ersten Argument anwenden.

Kehrt zurück:

Sammelreferenz < DocumentData , DocumentData >

Die CollectionReference .

Ausnahmen

Wenn der endgültige Pfad eine gleichmäßige Anzahl von Segmenten hat und nicht auf eine Sammlung verweist.

Sammelgruppe (Firestore, Sammlung)

Erstellt und gibt eine neue Query zurück, die alle Dokumente in der Datenbank enthält, die in einer Sammlung oder Unterkollektion mit der angegebenen collectionId enthalten sind .

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen	Ein Verweis auf die Firestore .
Sammlung	Zeichenfolge	Identifiziert die Sammlungen, um zu befragen. Jede Sammlung oder Unterkollektion mit dieser ID als letzte Segment seines Pfades wird enthalten. Kann keinen Schrägstrich enthalten.

Kehrt zurück:

Abfrage < DocumentData , DocumentData >

Die erstellte Query .

ConnectFirestoreemulator (Firestore, Host, Port, Optionen)

Ändern Sie diese Instanz, um mit dem Cloud Firestore -Emulator zu kommunizieren.

Hinweis: Dies muss aufgerufen werden, bevor diese Instanz für Operationen verwendet wurde.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen	Die Firestore -Instanz, die konfiguriert werden soll, um eine Verbindung zum Emulator herzustellen.
Gastgeber	Zeichenfolge	Der Emulator Host (Ex: Localhost).
Hafen	Nummer	Der Emulatorport (Ex: 9000).
Optionen	{MockUsertoken ?: emulatormockTokenoptions | String; }

Kehrt zurück:

Leere

Deaktivierung (Firestore)

Deaktiviert die Netzwerknutzung für diese Instanz. Es kann über Ensablenetwork wieder aktiviert werden () . Während das Netzwerk deaktiviert ist, werden alle Snapshot -Hörer, getDoc() oder getDocs() -Anläufe die Ergebnisse aus Cache zurückgeben, und alle Schreibvorgänge werden in der Warteschlange gestellt, bis das Netzwerk wiederhergestellt ist.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen

Kehrt zurück:

Versprechen <void>

Ein Promise , das nach deaktiviertem Netzwerk behoben ist.

DOC (Firestore, Pfad, PathSegmente)

Erhält eine DocumentReference , die sich auf das Dokument auf dem angegebenen Absolute -Pfad bezieht.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen	Ein Verweis auf die Firestore .
Weg	Zeichenfolge	Ein mit Slash getrennter Weg zu einem Dokument.
Pfadsegmente	String []	Zusätzliche Pfadsegmente, die relativ zum ersten Argument angewendet werden.

Kehrt zurück:

Dokumentverweis < DocumentData , DocumentData >

Die DocumentReference .

Ausnahmen

Wenn der letzte Pfad eine ungerade Anzahl von Segmenten hat und nicht auf ein Dokument verweist.

EnableIndexedDbpersistenz (Firestore, Persistencesettings)

Warnung: Diese API ist jetzt veraltet.

Diese Funktion wird in einer zukünftigen großen Veröffentlichung entfernt. Setzen Sie stattdessen FirestoreSettings.localCache auf eine Instanz von PersistentLocalCache , um den indizierten DB -Cache einzuschalten. Wenn Sie diese Funktion aufrufen, wenn FirestoreSettings.localCache bereits angegeben ist, wird eine Ausnahme ausgelöst.

Versuche, nach Möglichkeit eine anhaltende Lagerung zu ermöglichen.

enableIndexedDbPersistence() das Versprechen abgelehnt oder eine Ausnahme abgeben wird. Es gibt mehrere Gründe, warum dies fehlschlagen kann, was durch den code für den Fehler identifiziert werden kann.

* Fehlgeschlagene Vorkondition: Die App ist bereits in einem anderen Browser-Registerkarte geöffnet. * Unimplemented: Der Browser ist mit der Offline -Persistenz -Implementierung unvereinbar.

Beachten Sie, dass die Firestore -Instanz auch nach einem Fehler gebraucht bleibt, jedoch die Offline -Persistenz deaktiviert wird.

Hinweis: enableIndexedDbPersistence() muss vor anderen Funktionen aufgerufen werden (außer initializeFirestore () , getfirestore () oder clearIndexeddbpersistence () .

Persistenz kann in einer node.js -Umgebung nicht verwendet werden.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen	Die Firestore -Instanz, um die Persistenz für zu ermöglichen.
Persistencesettings	Persistencesettings	Optionale Einstellungen Objekt zur Konfiguration der Persistenz.

Kehrt zurück:

Versprechen <void>

Ein Promise , das erfolgreich eine anhaltende Speicherung ermöglicht.

EnableMultitabIndexeddbpersistenz (Firestore)

Warnung: Diese API ist jetzt veraltet.

Diese Funktion wird in einer zukünftigen großen Veröffentlichung entfernt. Setzen Sie stattdessen FirestoreSettings.localCache auf eine Instanz von PersistentLocalCache , um den indizierten DB -Cache einzuschalten. Wenn Sie diese Funktion aufrufen, wenn FirestoreSettings.localCache bereits angegeben ist, wird eine Ausnahme ausgelöst.

Versuche, nach Möglichkeit einen anhaltenden Speicher mit mehreren Tabellen zu ermöglichen. Wenn sie auf allen Registerkarten aktiviert sind, teilen alle Vorgänge den Zugriff auf lokale Persistenz, einschließlich der gemeinsamen Ausführung von Abfragen und latenzkompensierten lokalen Dokumentenaktualisierungen in allen verbundenen Instanzen.

Beim Versagen lehnt enableMultiTabIndexedDbPersistence() das Versprechen ab oder stellt eine Ausnahme ab. Es gibt mehrere Gründe, warum dies fehlschlagen kann, was durch den code für den Fehler identifiziert werden kann.

* Fehlgeschlagene Vorkondition: Die App ist bereits in einer anderen Browser-Registerkarte geöffnet und Multi-Tabs ist nicht aktiviert. * Unimplemented: Der Browser ist mit der Offline -Persistenz -Implementierung unvereinbar.

Beachten Sie, dass die Firestore -Instanz auch nach einem Fehler gebraucht bleibt, jedoch die Offline -Persistenz deaktiviert wird.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen	Die Firestore -Instanz, um die Persistenz für zu ermöglichen.

Kehrt zurück:

Versprechen <void>

Ein Promise , das erfolgreich eine anhaltende Speicherung ermöglicht.

Erleichterung (Firestore)

Nach einem vorherigen Anruf bei DeSablenTwork () werden die Nutzung des Netzwerks für diese Firestore- Instanz nach einem vorherigen Aufruf von DesablEnetwork erneut .

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen

Kehrt zurück:

Versprechen <void>

Ein Promise , das nach Aktivierung des Netzwerks gelöst wird.

GetPersistentcacheIndexManager (Firestore)

Gibt den persistentCache -Indexmanager zurück, der vom angegebenen Firestore -Objekt verwendet wird.

Die PersistentCacheIndexManager -Instanz oder null , wenn nicht lokaler persistierter Speicher verwendet wird.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen

Kehrt zurück:

PersistentCacheIndExManager | Null

LoadBundle (Firestore, Bundledata)

Lädt ein Firestore -Bundle in den lokalen Cache.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen	Die Firestore -Instanz zum Laden von Bundles für.
gebündelt	ReadablErtream <Uint8Array> | ArrayBuffer | Zeichenfolge	Ein Objekt, das das zu geladene Bundle darstellt. Gültige Objekte sind ArrayBuffer , ReadableStream<Uint8Array> oder string .

Kehrt zurück:

Lastbundletask

Ein LoadBundleTask -Objekt, das Anrufer mit Fortschrittsaktualisierungen und Fertigstellung oder Fehlerereignissen benachrichtigt. Es kann als Promise<LoadBundleTaskProgress> .

NamedQuery (Firestore, Name)

Liest eine Firestore -Abfrage aus dem lokalen Cache, das durch den angegebenen Namen identifiziert wurde.

Die benannten Abfragen werden auf der Serverseite (zusammen mit den resultierenden Dokumenten) in Bündel verpackt und mit loadBundle in den lokalen Cache geladen . Verwenden Sie diese Methode, um eine Abfrage mit Namen zu extrahieren.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen	Die Firestore -Instanz, um die Abfrage aus zu lesen.
Name	Zeichenfolge	Der Name der Abfrage.

Kehrt zurück:

Versprechen < Query | null>

Ein Promise , das mit der Abfrage oder null gelöst wird .

Onsnapshotsinsync (Firestore, Beobachter)

Fügen Sie einen Hörer für ein Snapshots-in-Sync-Ereignis hinzu. Das Snapshots-in-Sync-Ereignis zeigt, dass alle von einer bestimmten Änderung betroffenen Hörer ausgelöst wurden, auch wenn eine einzelne servergebägte Änderung mehrere Hörer betrifft.

Hinweis: Das Snapshots-in-Sync-Ereignis zeigt nur, dass die Hörer miteinander synchronisiert sind, sich jedoch nicht darauf beziehen, ob diese Schnappschüsse mit dem Server synchronisiert sind. Verwenden Sie Snapshotmetadata in den einzelnen Hörern, um festzustellen, ob sich ein Snapshot vom Cache oder dem Server stammt.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen	Die Instanz von Firestore zur Synchronisierung von Schnappschüssen.
Beobachter	{Weiter ?: (Wert: void) => void; Fehler ?: (Fehler: FirestoreError ) => void; komplett ?: () => void; }	Ein einzelnes Objekt, das next und error enthält.

Kehrt zurück:

Abbestellen

Eine Abbestellenfunktion, die aufgerufen werden kann, um den Snapshot -Listener abzubrechen.

Onsnapshotsinsync (Firestore, Onsync)

Fügen Sie einen Hörer für ein Snapshots-in-Sync-Ereignis hinzu. Das Snapshots-in-Sync-Ereignis zeigt, dass alle von einer bestimmten Änderung betroffenen Hörer ausgelöst wurden, auch wenn eine einzelne servergebägte Änderung mehrere Hörer betrifft.

Hinweis: Das Snapshots-in-Sync-Ereignis zeigt nur, dass die Hörer miteinander synchronisiert sind, sich jedoch nicht darauf beziehen, ob diese Schnappschüsse mit dem Server synchronisiert sind. Verwenden Sie SnapshotMetadata in den einzelnen Hörern, um festzustellen, ob sich ein Snapshot vom Cache oder dem Server stammt.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen	Die Firestore -Instanz zur Synchronisierung von Schnappschüssen.
Onsync	() => void	Ein Rückruf, der jedes Mal aufgerufen wird, wenn alle Schnappschusshörer miteinander synchronisiert werden.

Kehrt zurück:

Abbestellen

Eine Abbestellenfunktion, die aufgerufen werden kann, um den Snapshot -Listener abzubrechen.

Runtransaction (Firestore, UpdateFunction, Optionen)

Führt die angegebene updateFunction aus und versucht dann, die in der Transaktion angewendeten Änderungen zu begehen. Wenn sich ein Dokument, das in der updateFunction gelesen wurde . Wenn es nach 5 Versuchen nicht begeht, schlägt die Transaktion fehl.

Die maximale Anzahl der in einer einzelnen Transaktion zulässigen Schreibvorgänge beträgt 500.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen	Ein Verweis auf die Firestore -Datenbank, gegen die diese Transaktion ausführt.
Updatefunktion	(Transaktion: Transaktion ) => Versprechen <t>	Die Funktion, die im Transaktionskontext ausgeführt werden soll.
Optionen	Transaktionoptionen	Ein Optionsobjekt zur Konfiguration der maximalen Anzahl von Bestimmungsversuchen.

Kehrt zurück:

Versprechen <t>

Wenn die Transaktion erfolgreich abgeschlossen wurde oder explizit abgebrochen wurde (die updateFunction hat ein gescheitertes Versprechen zurückgegeben), wurde das von der updateFunction zurückgegebene Versprechen zurückgegeben wird hierher zurückgegeben. Andernfalls wird ein abgelehnter Versprechen mit dem entsprechenden Fehlerfehler zurückgegeben, wenn die Transaktion fehlgeschlagen ist.

setIndexConfiguration (Firestore, Konfiguration)

Diese API wird als Vorschau für Entwickler bereitgestellt und kann sich basierend auf dem von uns erhaltenen Feedback ändern. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Warnung: Diese API ist jetzt veraltet.

Anstatt Cache -Indizes manuell zu erstellen, sollten Sie enablePersistentCacheIndexAutoCreation() verwenden, um das SDK zu entscheiden, ob Cache -Indizes für lokal ausgeführte Abfragen erstellt werden sollen.

Konfigurieren Sie die Indexierung für die lokale Abfrageausführung. Jede vorherige Indexkonfiguration wird überschrieben. Das Promise löst, sobald die Indexkonfiguration bestanden wurde.

Die Indexeinträge selbst werden asynchron erstellt. Sie können weiterhin Abfragen verwenden, die eine Indexierung erfordern, auch wenn die Indizes noch nicht verfügbar sind. Die Abfrageausführung beginnt automatisch mit dem Index, sobald die Indexeinträge geschrieben wurden.

Indizes werden nur mit der IndexedDB -Persistenz unterstützt. Wenn IndexedDB nicht aktiviert ist, wird eine Indexkonfiguration ignoriert.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen	Die Firestore -Instanz, um Indizes für zu konfigurieren.
Aufbau	Indexkonfiguration	Die Indexdefinition.

Kehrt zurück:

Versprechen <void>

Ein Promise , das auflöst, sobald alle Indizes erfolgreich konfiguriert sind.

Ausnahmen

FireStoreError Wenn das JSON -Format ungültig ist.

setIndexConfiguration (Firestore, JSON)

Diese API wird als Vorschau für Entwickler bereitgestellt und kann sich basierend auf dem von uns erhaltenen Feedback ändern. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Warnung: Diese API ist jetzt veraltet.

Anstatt Cache -Indizes manuell zu erstellen, sollten Sie enablePersistentCacheIndexAutoCreation() verwenden, um das SDK zu entscheiden, ob Cache -Indizes für lokal ausgeführte Abfragen erstellt werden sollen.

Konfigurieren Sie die Indexierung für die lokale Abfrageausführung. Jede vorherige Indexkonfiguration wird überschrieben. Das Promise löst, sobald die Indexkonfiguration bestanden wurde.

Die Indexeinträge selbst werden asynchron erstellt. Sie können weiterhin Abfragen verwenden, die eine Indexierung erfordern, auch wenn die Indizes noch nicht verfügbar sind. Die Abfrageausführung beginnt automatisch mit dem Index, sobald die Indexeinträge geschrieben wurden.

Indizes werden nur mit der IndexedDB -Persistenz unterstützt. Rufen Sie entweder enableIndexedDbPersistence() oder enableMultiTabIndexedDbPersistence() auf, bevor Sie eine Indexkonfiguration festlegen. Wenn IndexedDB nicht aktiviert ist, wird eine Indexkonfiguration ignoriert.

Die Methode akzeptiert das von der Firebase CLI exportierte JSON -Format ( firebase firestore:indexes ). Wenn das JSON -Format ungültig ist, macht diese Methode einen Fehler.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen	Die Firestore -Instanz, um Indizes für zu konfigurieren.
json	Zeichenfolge	Das von der Firebase CLI exportierte JSON -Format.

Kehrt zurück:

Versprechen <void>

Ein Promise , das auflöst, sobald alle Indizes erfolgreich konfiguriert sind.

Ausnahmen

FireStoreError Wenn das JSON -Format ungültig ist.

enden (firestore)

Beendet die bereitgestellte Firestore -Instanz.

Nach dem Aufrufen terminate() kann nur die Funktion clearIndexedDbPersistence() verwendet werden. Jede andere Funktion wirft einen FirestoreError .

Um nach der Beendigung neu zu starten, erstellen Sie eine neue Instanz von FirebaseFirestore mit GetFirestore () .

Die Kündigung storniert keine anhängigen Schreibvorgänge, und Versprechen, die auf eine Antwort vom Server warten, werden nicht behoben. Wenn Sie Persistenz aktiviert haben, wird beim nächsten Start dieser Instanz das Senden dieser Schreibvorgänge an den Server fortgesetzt.

HINWEIS: Unter normalen Umständen ist es nicht erforderlich, terminate() zu rufen. Diese Funktion ist nur nützlich, wenn Sie diese Instanz dazu zwingen möchten, alle Ressourcen freizugeben, oder in Kombination mit clearIndexedDbPersistence() sicherzustellen, dass alle lokalen Staaten zwischen den Testläufen zerstört werden.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen

Kehrt zurück:

Versprechen <void>

Ein Promise , das bei der erfolgreichen Beendigung der Instanz entschlossen ist.

Waitforpendingwrites (Firestore)

Warten, bis alle derzeit anhängigen Schreibvorgänge für den aktiven Benutzer durch das Backend bestätigt wurden.

Das zurückgegebene Versprechen entscheidet sich sofort, wenn es keine ausstehenden Schreibvorgänge gibt. Andernfalls wartet das Versprechen auf alle zuvor ausgestellten Schreibvorgänge (einschließlich der in einer früheren App -Sitzung geschriebenen). Wenn Sie auf zusätzliche Schreibvorgänge warten möchten, rufen Sie waitForPendingWrites() erneut an.

Alle ausstehenden waitForPendingWrites() -Promises werden während der Änderungen des Benutzers abgelehnt.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen

Kehrt zurück:

Versprechen <void>

Ein Promise , das beschließt, wenn alle ausstehenden Schreibvorgänge vom Backend anerkannt wurden.

WriteBatch (Firestore)

Erstellt eine Schreibstapel, die zum Ausführen mehrerer Schreibvorgänge als einzelne Atomoperation verwendet wird. Die maximale Anzahl von Schreibvorgängen, die in einem einzigen WriteBatch zulässig sind, beträgt 500.

Im Gegensatz zu Transaktionen sind Schreibstapel offline bestehen und sind daher vorzuziehen, wenn Sie Ihre Schreibvorgänge nicht auf Lesedaten konditionieren müssen.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Firestore	Feuerladen

Kehrt zurück:

WriteBatch

Ein WriteBatch , mit dem mehrere Schreibvorgänge atomisch ausgeführt werden können.

Funktion()

zählen()

Erstellen Sie ein AggregateField -Objekt, mit dem die Anzahl der Dokumente im Ergebnissatz einer Abfrage berechnet werden kann.

Unterschrift:

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

Kehrt zurück:

Aggregatefield <nummer>

Deletefield ()

Gibt einen Sentinel für die Verwendung mit updateCoc () oder setDoc () mit {merge: true} zurück, um ein Feld für das Löschen zu markieren.

Unterschrift:

export declare function deleteField(): FieldValue;

Kehrt zurück:

Feldwert

Dokument Identifikation()

Gibt einen speziellen Sentinel FieldPath zurück, um auf die ID eines Dokuments zu verweisen. Es kann in Abfragen verwendet werden, um nach der Dokument -ID zu sortieren oder zu filtern.

Unterschrift:

export declare function documentId(): FieldPath;

Kehrt zurück:

Feldweg

GetFirestore ()

Gibt die vorhandene Standard -Firestore -Instanz zurück, die mit dem Standard -FirebaseApp verbunden ist . Wenn keine Instanz besteht, initialisiert eine neue Instanz mit Standardeinstellungen.

Unterschrift:

export declare function getFirestore(): Firestore;

Kehrt zurück:

Feuerladen

Die Standard -Firestore -Instanz der Standard -App.

MemoryAgergarbagleCollector ()

Schafft eine Instanz von MemoryEagerGarbageCollector . Dies ist auch der Standard -Müllsammler, es sei denn, er wird ausdrücklich anders angegeben.

Unterschrift:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

Kehrt zurück:

MemoryAgergarbagleCollector

persistentmultipletabmanager ()

Schafft eine Instanz von PersistentMultipleTabManager .

Unterschrift:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

Kehrt zurück:

Persistentmultipletabmanager

servertimestamp ()

Gibt einen Sentinel zurück, der mit SetDOC () oder updateCoc () verwendet wird, um einen servergebundenen Zeitstempel in die schriftlichen Daten einzubeziehen.

Unterschrift:

export declare function serverTimestamp(): FieldValue;

Kehrt zurück:

Feldwert

Funktion (DataBaseId, ...)

GetFirestore (DataBaseId)

Diese API wird als Vorschau für Entwickler bereitgestellt und kann sich basierend auf dem von uns erhaltenen Feedback ändern. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt die vorhandene benannte Firestore -Instanz zurück, die mit dem Standard -FirebaseApp verbunden ist . Wenn keine Instanz besteht, initialisiert eine neue Instanz mit Standardeinstellungen.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Datenbasis	Zeichenfolge	Der Name der Datenbank.

Kehrt zurück:

Feuerladen

Die benannte Firestore -Instanz der Standard -App.

Funktion (Elemente, ...)

ArrayRemove (Elemente)

Gibt einen speziellen Wert zurück, der mit setDoc () verwendet werden kann oder der dem Server die angegebene Elemente aus jedem Array -Wert entfernen kann, der bereits auf dem Server vorhanden ist. Alle Fälle jedes angegebenen Elements werden aus dem Array entfernt. Wenn das zu modifizierte Feld nicht bereits ein Array ist, wird es mit einem leeren Array überschrieben.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Elemente	Unbekannt[]	Die Elemente aus dem Array zu entfernen.

Kehrt zurück:

Feldwert

Der FieldValue -Sentinel zur Verwendung in einem Aufruf an setDoc() oder updateDoc()

Arrayunion (Elemente)

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Elemente	Unbekannt[]	The elements to union into the array.

Kehrt zurück:

Feldwert

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Feld	Zeichenfolge | FieldPath	Specifies the field to average across the result set.

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Feld	Zeichenfolge | FieldPath	Specifies the field to sum across the result set.

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
fieldPath	Zeichenfolge | FieldPath	The field to sort by.
directionStr	OrderByDirection	Optional direction to sort by ('asc' or 'desc'). If not specified, order will be ascending.

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
fieldPath	Zeichenfolge | FieldPath	The path to compare
opStr	WhereFilterOp	The operation string (eg "<", "<=", "==", "<", "<=", "!=").
Wert	Unbekannt	The value for comparison

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
fieldValues	Unbekannt[]	The field values to end this query at, in order of the query's order by.

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
fieldValues	Unbekannt[]	The field values to end this query before, in order of the query's order by.

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
fieldValues	Unbekannt[]	The field values to start this query after, in order of the query's order by.

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
fieldValues	Unbekannt[]	The field values to start this query at, in order of the query's order by.

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
indexManager	PersistentCacheIndexManager

Kehrt zurück:

Leere

disablePersistentCacheIndexAutoCreation(indexManager)

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

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
indexManager	PersistentCacheIndexManager

Kehrt zurück:

Leere

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.

Diese Funktion ist standardmäßig deaktiviert.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
indexManager	PersistentCacheIndexManager

Kehrt zurück:

Leere

function(left, ...)

aggregateFieldEqual(left, right)

Compares two 'AggregateField ` instances for equality.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
links	AggregateField <unbekannt>	Compare this AggregateField to the right .
Rechts	AggregateField <unbekannt>	Compare this AggregateField to the left .

Kehrt zurück:

Boolescher Wert

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
links	AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType>	The first AggregateQuerySnapshot to compare.
Rechts	AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType>	The second AggregateQuerySnapshot to compare.

Kehrt zurück:

Boolescher Wert

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
links	Abfrage <AppModelType, DbModelType>	A Query to compare.
Rechts	Abfrage <AppModelType, DbModelType>	A Query to compare.

Kehrt zurück:

Boolescher Wert

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
links	Dokumentverweis <AppModelType, DbModelType> | CollectionReference <AppModelType, DbModelType>	A reference to compare.
Rechts	Dokumentverweis <AppModelType, DbModelType> | CollectionReference <AppModelType, DbModelType>	A reference to compare.

Kehrt zurück:

Boolescher Wert

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
links	DocumentSnapshot <AppModelType, DbModelType> | QuerySnapshot <AppModelType, DbModelType>	A snapshot to compare.
Rechts	DocumentSnapshot <AppModelType, DbModelType> | QuerySnapshot <AppModelType, DbModelType>	A snapshot to compare.

Kehrt zurück:

Boolescher Wert

true if the snapshots are equal.

function(limit, ...)

limit(limit)

Creates a QueryLimitConstraint that only returns the first matching documents.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Grenze	Nummer	The maximum number of items to return.

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Grenze	Nummer	The maximum number of items to return.

Kehrt zurück:

QueryLimitConstraint

The created QueryLimitConstraint .

function(logLevel, ...)

setLogLevel(logLevel)

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

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
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.

Kehrt zurück:

Leere

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
N	Nummer	The value to increment by.

Kehrt zurück:

Feldwert

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Abfrage	Abfrage <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.

Kehrt zurück:

Promise< AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType>>

Beispiel

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Abfrage	Abfrage <AppModelType, DbModelType>	The query whose result set size is calculated.

Kehrt zurück:

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() .

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Abfrage	Abfrage <AppModelType, DbModelType>

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Abfrage	Abfrage <AppModelType, DbModelType>

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Abfrage	Abfrage <AppModelType, DbModelType>

Kehrt zurück:

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.

Unterschrift:

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;

Parameter

Parameter	Typ	Beschreibung
Abfrage	Abfrage <AppModelType, DbModelType>	The query to listen to.
Beobachter	{ next?: (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; }	A single object containing next and error callbacks.

Kehrt zurück:

Abbestellen

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.

Unterschrift:

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;

Parameter

Parameter	Typ	Beschreibung
Abfrage	Abfrage <AppModelType, DbModelType>	The query to listen to.
Optionen	SnapshotListenOptions	Options controlling the listen behavior.
Beobachter	{ next?: (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; }	A single object containing next and error callbacks.

Kehrt zurück:

Abbestellen

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.

Unterschrift:

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;

Parameter

Parameter	Typ	Beschreibung
Abfrage	Abfrage <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.
bei Fertigstellung	() => void	Can be provided, but will not be called since streams are never ending.

Kehrt zurück:

Abbestellen

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.

Unterschrift:

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;

Parameter

Parameter	Typ	Beschreibung
Abfrage	Abfrage <AppModelType, DbModelType>	The query to listen to.
Optionen	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.
bei Fertigstellung	() => void	Can be provided, but will not be called since streams are never ending.

Kehrt zurück:

Abbestellen

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Abfrage	Abfrage <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() , Grenze() ).

Kehrt zurück:

Abfrage <AppModelType, DbModelType>

Ausnahmen

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Abfrage	Abfrage <AppModelType, DbModelType>	The Query instance to use as a base for the new constraints.
queryConstraints	QueryConstraint []	The list of QueryConstraint s to apply.

Kehrt zurück:

Abfrage <AppModelType, DbModelType>

Ausnahmen

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
queryConstraints	QueryFilterConstraint []	Optional. The list of QueryFilterConstraint s to perform a conjunction for. These must be created with calls to where() , oder() , oder und() .

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
queryConstraints	QueryFilterConstraint []	Optional. The list of QueryFilterConstraint s to perform a disjunction for. These must be created with calls to where() , oder() , oder und() .

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Referenz	CollectionReference <AppModelType, DbModelType>	A reference to the collection to add this document to.
Daten	WithFieldValue <AppModelType>	An Object containing the data for the new document.

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Referenz	CollectionReference <AppModelType, DbModelType>	A reference to a collection.
Weg	Zeichenfolge	A slash-separated path to a collection.
pathSegments	string[]	Additional path segments to apply relative to the first argument.

Kehrt zurück:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

Ausnahmen

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Referenz	Dokumentverweis <AppModelType, DbModelType>	A reference to a Firestore document.
Weg	Zeichenfolge	A slash-separated path to a collection.
pathSegments	string[]	Additional path segments that will be applied relative to the first argument.

Kehrt zurück:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

Ausnahmen

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 .

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Referenz	Dokumentverweis <AppModelType, DbModelType>	A reference to the document to delete.

Kehrt zurück:

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 .

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Referenz	CollectionReference <AppModelType, DbModelType>	A reference to a collection.
Weg	Zeichenfolge	A slash-separated path to a document. Has to be omitted to use auto-genrated IDs.
pathSegments	string[]	Additional path segments that will be applied relative to the first argument.

Kehrt zurück:

Dokumentverweis <AppModelType, DbModelType>

The DocumentReference instance.

Ausnahmen

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Referenz	Dokumentverweis <AppModelType, DbModelType>	A reference to a Firestore document.
Weg	Zeichenfolge	A slash-separated path to a document.
pathSegments	string[]	Additional path segments that will be applied relative to the first argument.

Kehrt zurück:

Dokumentverweis < DocumentData , DocumentData >

The DocumentReference instance.

Ausnahmen

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() .

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Referenz	Dokumentverweis <AppModelType, DbModelType>	The reference of the document to fetch.

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Referenz	Dokumentverweis <AppModelType, DbModelType>

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Referenz	Dokumentverweis <AppModelType, DbModelType>

Kehrt zurück:

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.

Unterschrift:

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;

Parameter

Parameter	Typ	Beschreibung
Referenz	Dokumentverweis <AppModelType, DbModelType>	A reference to the document to listen to.
Beobachter	{ next?: (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; }	A single object containing next and error callbacks.

Kehrt zurück:

Abbestellen

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.

Unterschrift:

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;

Parameter

Parameter	Typ	Beschreibung
Referenz	Dokumentverweis <AppModelType, DbModelType>	A reference to the document to listen to.
Optionen	SnapshotListenOptions	Options controlling the listen behavior.
Beobachter	{ next?: (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; }	A single object containing next and error callbacks.

Kehrt zurück:

Abbestellen

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.

Unterschrift:

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;

Parameter

Parameter	Typ	Beschreibung
Referenz	Dokumentverweis <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.
bei Fertigstellung	() => void	Can be provided, but will not be called since streams are never ending.

Kehrt zurück:

Abbestellen

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.

Unterschrift:

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;

Parameter

Parameter	Typ	Beschreibung
Referenz	Dokumentverweis <AppModelType, DbModelType>	A reference to the document to listen to.
Optionen	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.
bei Fertigstellung	() => void	Can be provided, but will not be called since streams are never ending.

Kehrt zurück:

Abbestellen

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Referenz	Dokumentverweis <AppModelType, DbModelType>	A reference to the document to write.
Daten	WithFieldValue <AppModelType>	A map of the fields and values for the document.

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Referenz	Dokumentverweis <AppModelType, DbModelType>	A reference to the document to write.
Daten	PartialWithFieldValue <AppModelType>	A map of the fields and values for the document.
Optionen	SetOptions	An object to configure the set behavior.

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Referenz	Dokumentverweis <AppModelType, DbModelType>	A reference to the document to update.
Daten	Daten aktualisieren <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.

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Referenz	Dokumentverweis <AppModelType, DbModelType>	A reference to the document to update.
Feld	Zeichenfolge | FieldPath	The first field to update.
Wert	Unbekannt	The first value.
moreFieldsAndValues	Unbekannt[]	Additional key value pairs.

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Einstellungen	MemoryCacheSettings

Kehrt zurück:

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).

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Einstellungen	{ cacheSizeBytes?: number; }

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Einstellungen	PersistentCacheSettings

Kehrt zurück:

PersistentLocalCache

persistentSingleTabManager(settings)

Creates an instance of PersistentSingleTabManager .

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Einstellungen	PersistentSingleTabManagerSettings | nicht definiert	Configures the created tab manager.

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Schnappschuss	DocumentSnapshot <AppModelType, DbModelType>	The snapshot of the document to end at.

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Schnappschuss	DocumentSnapshot <AppModelType, DbModelType>	The snapshot of the document to end before.

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Schnappschuss	DocumentSnapshot <AppModelType, DbModelType>	The snapshot of the document to start after.

Kehrt zurück:

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.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Schnappschuss	DocumentSnapshot <AppModelType, DbModelType>	The snapshot of the document to start at.

Kehrt zurück:

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.

Unterschrift:

CACHE_SIZE_UNLIMITED = -1

AddPrefixToKeys

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

Unterschrift:

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.

Unterschrift:

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 .

Unterschrift:

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.

Unterschrift:

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

Unterschrift:

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'.

Unterschrift:

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.

Unterschrift:

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.

Unterschrift:

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.

Unterschrift:

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

MemoryGarbageCollector

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

Unterschrift:

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

Unterschrift:

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).

Unterschrift:

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.

Unterschrift:

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.

Unterschrift:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

Primitive

Primitive types.

Unterschrift:

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

QueryConstraintType

Describes the different query constraints available in this SDK.

Unterschrift:

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

QueryFilterConstraint

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

Unterschrift:

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() , anfangen bei() , startAfter() , endBefore() , endAt() , limit() or limitToLast() and can then be passed to query() to create a new query instance that also contains the QueryConstraint .

Unterschrift:

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 .

Unterschrift:

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.

Unterschrift:

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 -Typ

Unterschrift:

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

Daten aktualisieren

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.

Unterschrift:

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'.

Unterschrift:

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.

Unterschrift:

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