database package

Firebase-Echtzeitdatenbank

Funktionen

Klassen

Schnittstellen

Geben Sie Aliase ein

Funktion(App, ...)

getDatabase(app, url)

Gibt die Instanz des Realtime Database SDK zurück, die der bereitgestellten FirebaseApp zugeordnet ist . Initialisiert eine neue Instanz mit Standardeinstellungen, wenn keine Instanz vorhanden ist oder wenn die vorhandene Instanz eine benutzerdefinierte Datenbank-URL verwendet.

Unterschrift:

export declare function getDatabase(app?: FirebaseApp, url?: string): Database;

Parameter

Kehrt zurück:

Datenbank

Die Database der bereitgestellten App.

Funktion (db, ...)

ConnectDatabaseEmulator (DB, Host, Port, Optionen)

Ändern Sie die bereitgestellte Instanz, um mit dem Echtzeit -Datenbankemulator zu kommunizieren.

HINWEIS: Diese Methode muss vor der Durchführung einer anderen Operation aufgerufen werden.

Unterschrift:

export declare function connectDatabaseEmulator(db: Database, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

Parameter

Kehrt zurück:

Leere

Gooffline (DB)

Trennungen vom Server (alle Datenbankvorgänge werden offline abgeschlossen).

Der Client verwaltet automatisch eine anhaltende Verbindung zum Datenbankserver, der auf unbestimmte Zeit aktiv bleibt und beim Trennen wieder verbunden bleibt. Die Methoden goOffline() und goOnline() können jedoch verwendet werden, um die Client -Verbindung in Fällen zu steuern, in denen eine anhaltende Verbindung unerwünscht ist.

Offline empfängt der Client keine Datenaktualisierungen mehr aus der Datenbank. Alle lokal durchgeführten Datenbankvorgänge werden jedoch weiterhin sofort Ereignisse abfeuern, sodass sich Ihre Anwendung weiterhin normal verhalten kann. Darüber hinaus wird jeder lokal ausgeführte Vorgang automatisch in der Warteschlange gestellt und nach einer erneuten Verbindung mit dem Datenbankserver wiedergegeben.

Um sich wieder mit der Datenbank zu verbinden und Remote -Ereignisse zu erhalten, siehe goOnline() .

Unterschrift:

export declare function goOffline(db: Database): void;

Parameter

Kehrt zurück:

Leere

goOnline(db)

Verbinden Sie den Server wieder und synchronisieren den Offline -Datenbankstatus mit dem Serverstatus.

Diese Methode sollte nach Deaktivieren der aktiven Verbindung mit goOffline() verwendet werden . Sobald der Client wieder verbunden ist, überträgt er die richtigen Daten und schießt die entsprechenden Ereignisse so aus, dass Ihr Kunde automatisch aufholt.

Unterschrift:

export declare function goOnline(db: Database): void;

Parameter

Kehrt zurück:

Leere

REF (DB, Pfad)

Gibt eine Reference zurück, die den Speicherort in der Datenbank darstellt, die dem bereitgestellten Pfad entspricht. Wenn kein Pfad bereitgestellt wird, weist die Reference auf das Stamm der Datenbank hin.

Unterschrift:

export declare function ref(db: Database, path?: string): DatabaseReference;

Parameter

Kehrt zurück:

Datenbankerferenz

Wenn ein Pfad bereitgestellt wird, zeigt eine Reference auf den bereitgestellten Pfad. Ansonsten eine Reference die auf das Stammvermögen der Datenbank zeigt.

Reffromurl (DB, URL)

Gibt eine Reference zurück, die den Speicherort in der Datenbank darstellt, die der bereitgestellten Firebase -URL entspricht.

Eine Ausnahme wird ausgelöst, wenn die URL keine gültige Firebase -Datenbank -URL ist oder eine andere Domäne hat als die aktuelle Database .

Beachten Sie, dass alle Abfrageparameter ( orderBy , limitToLast usw.) werden ignoriert und nicht auf die zurückgegebene Reference angewendet .

Unterschrift:

export declare function refFromURL(db: Database, url: string): DatabaseReference;

Parameter

Kehrt zurück:

Datenbankerferenz

Eine Reference , die auf die bereitgestellte Feuerbasis -URL zeigt.

Funktion()

Forcelongpolling ()

Erzwingen Sie die Verwendung von Longpolling anstelle von Websockets. Dies wird ignoriert, wenn das WebSocket -Protokoll in Databaseurl verwendet wird.

Unterschrift:

export declare function forceLongPolling(): void;

Kehrt zurück:

Leere

ForceWebsockets ()

Erzwingen Sie die Verwendung von Websockets anstelle von Longpolling.

Unterschrift:

export declare function forceWebSockets(): void;

Kehrt zurück:

Leere

OrderByKey ()

Erstellt eine neue QueryConstraint , die nach dem Schlüssel ordnet.

Sortiert die Ergebnisse einer Abfrage nach ihren (aufsteigenden) Schlüsselwerten.

Sie können mehr über orderByKey() in sortierenden Daten lesen .

Unterschrift:

export declare function orderByKey(): QueryConstraint;

Kehrt zurück:

QueryConstraint

OrderByPriority ()

Erstellt eine neue QueryConstraint , die nach Priorität ordnet.

Anwendungen müssen keine Priorität verwenden, können Sammlungen jedoch nach ordentlichen Eigenschaften bestellen (sortieren Sie Sortierdaten für Alternativen zur Priorität.

Unterschrift:

export declare function orderByPriority(): QueryConstraint;

Kehrt zurück:

QueryConstraint

OrderByValue ()

Erstellt eine neue QueryConstraint , die nach Wert ordnet.

Wenn die Kinder einer Abfrage alle Skalarwerte sind (Zeichenfolge, Zahl oder Boolesche), können Sie die Ergebnisse nach ihren (aufsteigenden) Werten bestellen.

Sie können mehr über orderByValue() in Sortierdaten lesen .

Unterschrift:

export declare function orderByValue(): QueryConstraint;

Kehrt zurück:

QueryConstraint

servertimestamp ()

Gibt einen Platzhalterwert für die automatische Bevölkerung des aktuellen Zeitstempels (Zeit seit der Unix-Epoche in Millisekunden) zurück, wie von den Firebase-Servern bestimmt.

Unterschrift:

export declare function serverTimestamp(): object;

Kehrt zurück:

Objekt

Funktion (Delta, ...)

Inkrement (Delta)

Gibt einen Platzhalterwert zurück, der verwendet werden kann, um den aktuellen Datenbankwert durch das bereitgestellte Delta atomisch zu erhöhen.

Unterschrift:

export declare function increment(delta: number): object;

Parameter

Kehrt zurück:

Objekt

Ein Platzhalterwert für die Änderung von Daten atomisch serverseitig.

Funktion (aktiviert, ...)

enableLogging(aktiviert, dauerhaft)

Protokolliert Informationen an die Konsole.

Unterschrift:

export declare function enableLogging(enabled: boolean, persistent?: boolean): any;

Parameter

Kehrt zurück:

beliebig

Funktion (Limit, ...)

limitToFirst(limit)

Erstellt eine neue QueryConstraint , die auf die erste spezifische Anzahl von Kindern beschränkt ist.

Die limitToFirst() -Methode wird verwendet, um eine maximale Anzahl von Kindern festzulegen, die für einen bestimmten Rückruf synchronisiert werden sollen. Wenn wir ein Limit von 100 festlegen, erhalten wir zunächst nur bis zu 100 child_added -Ereignisse. Wenn wir weniger als 100 Nachrichten in unserer Datenbank gespeichert haben, wird für jede Nachricht ein child_added -Ereignis abgefeuert. Wenn wir jedoch über 100 Nachrichten haben, erhalten wir nur ein child_added -Ereignis für die ersten 100 bestellten Nachrichten. Wenn sich die Elemente ändern, erhalten wir child_removed -Ereignisse für jedes Element, das aus der aktiven Liste herausfällt, so dass die Gesamtzahl bei 100 bleibt.

Sie können mehr über limitToFirst() lesen, um Daten zu filtern .

Unterschrift:

export declare function limitToFirst(limit: number): QueryConstraint;

Parameter

Kehrt zurück:

QueryConstraint

limitToLast(limit)

Erstellt eine neue QueryConstraint , die darauf beschränkt ist, nur die zuletzt angegebene Anzahl von Kindern zurückzugeben.

Die limitToLast() -Methode wird verwendet, um eine maximale Anzahl von Kindern festzulegen, die für einen bestimmten Rückruf synchronisiert werden sollen. Wenn wir ein Limit von 100 festlegen, erhalten wir zunächst nur bis zu 100 child_added -Ereignisse. Wenn wir weniger als 100 Nachrichten in unserer Datenbank gespeichert haben, wird für jede Nachricht ein child_added -Ereignis abgefeuert. Wenn wir jedoch über 100 Nachrichten haben, erhalten wir für die letzten 100 bestellten Nachrichten nur ein child_added -Ereignis. Wenn sich die Elemente ändern, erhalten wir child_removed -Ereignisse für jedes Element, das aus der aktiven Liste herausfällt, so dass die Gesamtzahl bei 100 bleibt.

Sie können mehr über limitToLast() in Filterdaten lesen .

Unterschrift:

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

Parameter

Kehrt zurück:

QueryConstraint

Funktion (Logger, ...)

EnableLogging (Logger)

Protokolliert Informationen an die Konsole.

Unterschrift:

export declare function enableLogging(logger: (message: string) => unknown): any;

Parameter

Kehrt zurück:

beliebig

Funktion (Eltern, ...)

Kind (Elternteil, Pfad)

Erhält eine Reference für den Ort auf dem angegebenen relativen Pfad.

Der relative Pfad kann entweder ein einfacher untergeordneter Name (z. B. "ADA") oder ein tieferer, mit getriebener, getrennter Pfad (z. B. "ADA/Name/First") sein.

Unterschrift:

export declare function child(parent: DatabaseReference, path: string): DatabaseReference;

Parameter

Kehrt zurück:

Datenbankerferenz

Der angegebene Kinderort.

push(parent, value)

Generiert einen neuen Kinderort mit einem eindeutigen Schlüssel und gibt seine Reference zurück .

Dies ist das häufigste Muster zum Hinzufügen von Daten zu einer Sammlung von Elementen.

Wenn Sie einen Wert zum push() geben Der Wert wird an den erzeugten Ort geschrieben. Wenn Sie keinen Wert übergeben, wird nichts in die Datenbank geschrieben und das Kind bleibt leer (aber Sie können die Reference an anderer Stelle verwenden).

Die einzigartigen Schlüssel, die von push() erzeugt werden, werden nach der aktuellen Zeit bestellt, sodass die resultierende Liste der Elemente chronologisch sortiert ist. Die Schlüssel sind auch unbehaglich ausgelegt (sie enthalten 72 zufällige Entropiestoffe).

Siehe Anhang zu einer Liste von Daten . Siehe die 2^120 Möglichkeiten, um einzigartige Kennungen zu gewährleisten .

Unterschrift:

export declare function push(parent: DatabaseReference, value?: unknown): ThenableReference;

Parameter

Kehrt zurück:

Dann ABLEFERVERVENDE

Kombiniertes Promise und Reference ; Auflösungen, wenn das Schreiben abgeschlossen ist, kann jedoch sofort als Reference auf den untergeordneten Standort verwendet werden.

Funktion (Pfad, ...)

OrderBychild (Pfad)

Erstellt eine neue QueryConstraint , die nach dem angegebenen Kinderschlüssel ordnet.

Abfragen können jeweils nur nach einem Schlüssel bestellen. Auf derselben Abfrage orderByChild() auf derselben Abfrage zu rufen ist ein Fehler.

Mit Firebase -Abfragen können Sie Ihre Daten nach einem beliebigen Kinderschlüssel bestellen. Wenn Sie jedoch im Voraus wissen, was Ihre Indizes sein werden, können Sie sie über die .Indexon -Regel in Ihren Sicherheitsregeln für eine bessere Leistung definieren. Weitere Informationen finden Sie unter https://firebase.google.com/docs/database/security/indexing-data-Regel .

Sie können mehr über orderByChild() in sortierenden Daten lesen .

Unterschrift:

export declare function orderByChild(path: string): QueryConstraint;

Parameter

Kehrt zurück:

QueryConstraint

Funktion (Abfrage, ...)

Holen Sie sich (Abfrage)

Erhält das aktuellste Ergebnis für diese Abfrage.

Unterschrift:

export declare function get(query: Query): Promise<DataSnapshot>;

Parameter

Kehrt zurück:

Versprechen Sie < datasNapshot >

Ein Promise , das sich in den resultierenden Datennapshot auflöst, wenn ein Wert verfügbar ist, oder ablehnt, ob der Client keinen Wert zurückgeben kann (z. B. wenn der Server nicht erreichbar ist und nichts zwischengespeichert wird).

Aus (Abfrage, EventType, Rückruf)

onValue einen Rückruf on*() , onChildAdded ) Zuhörer. Hinweis: Dies ist nicht die empfohlene Möglichkeit, einen Hörer zu entfernen. Verwenden Sie stattdessen die zurückgegebene Rückruffunktion von der on* Rückrufe.

Lösen Sie einen Rückruf, der zuvor on*() beigefügt war . Wenn Sie off() bei einem Elternhörer anrufen, werden die auf Kinderknoten registrierten Hörer nicht automatisch entfernt. off() muss auch unter den Hörern aufgerufen werden, um den Rückruf zu entfernen.

Wenn kein Rückruf angegeben ist, werden alle Rückrufe für den angegebenen EventType entfernt. Wenn kein EventType angegeben ist, werden alle Rückrufe für die Reference entfernt.

Einzelne Zuhörer können auch entfernt werden, indem sie ihre Rückrufe aufrufen.

Unterschrift:

export declare function off(query: Query, eventType?: EventType, callback?: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown): void;

Parameter

Kehrt zurück:

Leere

Onchildadded (Abfrage, Rückruf, AbbrechenCallback)

Hört auf Datenänderungen an einem bestimmten Ort.

Dies ist die primäre Möglichkeit, Daten aus einer Datenbank zu lesen. Ihr Rückruf wird für die anfänglichen Daten und erneut ausgelöst, wenn sich die Daten ändert. Rufen Sie den zurückgegebenen Rückruf auf, um die Empfang von Updates einzustellen. Weitere Informationen finden Sie im Internet ab .

Ein onChildAdded -Ereignis wird für jedes erste Kind an diesem Ort einmal ausgelöst und wird jedes Mal erneut ausgelöst, wenn ein neues Kind hinzugefügt wird. Der in den Rückruf übergebene DataSnapshot spiegelt die Daten für das entsprechende Kind wider. Zu den Bestellungszwecken wird ein zweites Argument verabschiedet, bei dem es sich um eine Zeichenfolge handelt, die den Schlüssel des vorherigen Geschwisterkindes durch Sortierordnung enthält, oder null , wenn es das erste Kind ist.

Unterschrift:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parameter

Kehrt zurück:

Abbestellen

Eine Funktion, die aufgerufen werden kann, um den Hörer zu entfernen.

onChildAdded(Abfrage, Rückruf, Optionen)

Hört auf Datenänderungen an einem bestimmten Ort.

Dies ist die primäre Möglichkeit, Daten aus einer Datenbank zu lesen. Ihr Rückruf wird für die anfänglichen Daten und erneut ausgelöst, wenn sich die Daten ändert. Rufen Sie den zurückgegebenen Rückruf auf, um die Empfang von Updates einzustellen. Weitere Informationen finden Sie im Internet ab .

Ein onChildAdded -Ereignis wird für jedes erste Kind an diesem Ort einmal ausgelöst und wird jedes Mal erneut ausgelöst, wenn ein neues Kind hinzugefügt wird. Der in den Rückruf übergebene DataSnapshot spiegelt die Daten für das entsprechende Kind wider. Zu den Bestellungszwecken wird ein zweites Argument verabschiedet, bei dem es sich um eine Zeichenfolge handelt, die den Schlüssel des vorherigen Geschwisterkindes durch Sortierordnung enthält, oder null , wenn es das erste Kind ist.

Unterschrift:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Kehrt zurück:

Abbestellen

Eine Funktion, die aufgerufen werden kann, um den Hörer zu entfernen.

Onchildadded (Abfrage, Rückruf, AbbrechenCallback, Optionen)

Hört auf Datenänderungen an einem bestimmten Ort.

Dies ist die primäre Möglichkeit, Daten aus einer Datenbank zu lesen. Ihr Rückruf wird für die anfänglichen Daten und erneut ausgelöst, wenn sich die Daten ändert. Rufen Sie den zurückgegebenen Rückruf auf, um die Empfang von Updates einzustellen. Weitere Informationen finden Sie im Internet ab .

Ein onChildAdded -Ereignis wird für jedes erste Kind an diesem Ort einmal ausgelöst und wird jedes Mal erneut ausgelöst, wenn ein neues Kind hinzugefügt wird. Der in den Rückruf übergebene DataSnapshot spiegelt die Daten für das entsprechende Kind wider. Zu den Bestellungszwecken wird ein zweites Argument verabschiedet, bei dem es sich um eine Zeichenfolge handelt, die den Schlüssel des vorherigen Geschwisterkindes durch Sortierordnung enthält, oder null , wenn es das erste Kind ist.

Unterschrift:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Kehrt zurück:

Abbestellen

Eine Funktion, die aufgerufen werden kann, um den Hörer zu entfernen.

OnchildChanged (Abfrage, Rückruf, Abbrechencallback)

Hört auf Datenänderungen an einem bestimmten Ort.

Dies ist die primäre Möglichkeit, Daten aus einer Datenbank zu lesen. Ihr Rückruf wird für die anfänglichen Daten und erneut ausgelöst, wenn sich die Daten ändert. Rufen Sie den zurückgegebenen Rückruf auf, um die Empfang von Updates einzustellen. Weitere Informationen finden Sie im Internet ab .

Ein onChildChanged -Ereignis wird ausgelöst, wenn die in einem Kind (oder eines seiner Nachkommen) gespeicherten Daten ändert. Beachten Sie, dass ein einzelnes child_changed -Ereignis mehrere Änderungen am Kind darstellen kann. Der an den Rückruf übergebene DataSnapshot enthält den neuen Kindergehalt. Für Bestellzwecke wird der Rückruf auch ein zweites Argument verabschiedet, bei dem es sich um eine Zeichenfolge handelt, die den Schlüssel des vorherigen Geschwisterkindes durch Sortierordnung enthält, oder null , wenn es das erste Kind ist.

Unterschrift:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parameter

Kehrt zurück:

Abbestellen

Eine Funktion, die aufgerufen werden kann, um den Hörer zu entfernen.

OnchildChanged (Abfrage, Rückruf, Optionen)

Hört auf Datenänderungen an einem bestimmten Ort.

Dies ist die primäre Möglichkeit, Daten aus einer Datenbank zu lesen. Ihr Rückruf wird für die anfänglichen Daten und erneut ausgelöst, wenn sich die Daten ändert. Rufen Sie den zurückgegebenen Rückruf auf, um die Empfang von Updates einzustellen. Weitere Informationen finden Sie im Internet ab .

Ein onChildChanged -Ereignis wird ausgelöst, wenn die in einem Kind (oder eines seiner Nachkommen) gespeicherten Daten ändert. Beachten Sie, dass ein einzelnes child_changed -Ereignis mehrere Änderungen am Kind darstellen kann. Der an den Rückruf übergebene DataSnapshot enthält den neuen Kindergehalt. Für Bestellzwecke wird der Rückruf auch ein zweites Argument verabschiedet, bei dem es sich um eine Zeichenfolge handelt, die den Schlüssel des vorherigen Geschwisterkindes durch Sortierordnung enthält, oder null , wenn es das erste Kind ist.

Unterschrift:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Kehrt zurück:

Abbestellen

Eine Funktion, die aufgerufen werden kann, um den Hörer zu entfernen.

onChildChanged(Abfrage, Rückruf, cancelCallback, Optionen)

Hört auf Datenänderungen an einem bestimmten Ort.

Dies ist die primäre Möglichkeit, Daten aus einer Datenbank zu lesen. Ihr Rückruf wird für die anfänglichen Daten und erneut ausgelöst, wenn sich die Daten ändert. Rufen Sie den zurückgegebenen Rückruf auf, um die Empfang von Updates einzustellen. Weitere Informationen finden Sie im Internet ab .

Ein onChildChanged -Ereignis wird ausgelöst, wenn die in einem Kind (oder eines seiner Nachkommen) gespeicherten Daten ändert. Beachten Sie, dass ein einzelnes child_changed -Ereignis mehrere Änderungen am Kind darstellen kann. Der an den Rückruf übergebene DataSnapshot enthält den neuen Kindergehalt. Für Bestellzwecke wird der Rückruf auch ein zweites Argument verabschiedet, bei dem es sich um eine Zeichenfolge handelt, die den Schlüssel des vorherigen Geschwisterkindes durch Sortierordnung enthält, oder null , wenn es das erste Kind ist.

Unterschrift:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Kehrt zurück:

Abbestellen

Eine Funktion, die aufgerufen werden kann, um den Hörer zu entfernen.

onChildMoved(query, callback, cancelCallback)

Hört auf Datenänderungen an einem bestimmten Ort.

Dies ist die primäre Möglichkeit, Daten aus einer Datenbank zu lesen. Ihr Rückruf wird für die anfänglichen Daten und erneut ausgelöst, wenn sich die Daten ändert. Rufen Sie den zurückgegebenen Rückruf auf, um die Empfang von Updates einzustellen. Weitere Informationen finden Sie im Internet ab .

Ein onChildMoved -Ereignis wird ausgelöst, wenn sich die Sortierreihenfolge eines Kindes ändert, so dass sich seine Position zu seinen Geschwistern ändert. Der an den Rückruf übergebene DataSnapshot ist für die Daten des Kindes, das sich verschoben hat, erfolgt. Es wird auch ein zweites Argument verabschiedet, bei dem es sich um eine Zeichenfolge handelt, die den Schlüssel des vorherigen Geschwisterkindes durch Sortierreihenfolge enthält, oder null , wenn es das erste Kind ist.

Unterschrift:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parameter

Kehrt zurück:

Abbestellen

Eine Funktion, die aufgerufen werden kann, um den Hörer zu entfernen.

OnchildMoved (Abfrage, Rückruf, Optionen)

Hört auf Datenänderungen an einem bestimmten Ort.

Dies ist die primäre Möglichkeit, Daten aus einer Datenbank zu lesen. Ihr Rückruf wird für die anfänglichen Daten und erneut ausgelöst, wenn sich die Daten ändert. Rufen Sie den zurückgegebenen Rückruf auf, um die Empfang von Updates einzustellen. Weitere Informationen finden Sie im Internet ab .

Ein onChildMoved -Ereignis wird ausgelöst, wenn sich die Sortierreihenfolge eines Kindes ändert, so dass sich seine Position zu seinen Geschwistern ändert. Der an den Rückruf übergebene DataSnapshot ist für die Daten des Kindes, das sich verschoben hat, erfolgt. Es wird auch ein zweites Argument verabschiedet, bei dem es sich um eine Zeichenfolge handelt, die den Schlüssel des vorherigen Geschwisterkindes durch Sortierreihenfolge enthält, oder null , wenn es das erste Kind ist.

Unterschrift:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Kehrt zurück:

Abbestellen

Eine Funktion, die aufgerufen werden kann, um den Hörer zu entfernen.

OnchildMoved (Abfrage, Rückruf, Abbrechencallback, Optionen)

Hört auf Datenänderungen an einem bestimmten Ort.

Dies ist die primäre Möglichkeit, Daten aus einer Datenbank zu lesen. Ihr Rückruf wird für die anfänglichen Daten und erneut ausgelöst, wenn sich die Daten ändert. Rufen Sie den zurückgegebenen Rückruf auf, um die Empfang von Updates einzustellen. Weitere Informationen finden Sie im Internet ab .

Ein onChildMoved -Ereignis wird ausgelöst, wenn sich die Sortierreihenfolge eines Kindes ändert, so dass sich seine Position zu seinen Geschwistern ändert. Der an den Rückruf übergebene DataSnapshot ist für die Daten des Kindes, das sich verschoben hat, erfolgt. Es wird auch ein zweites Argument verabschiedet, bei dem es sich um eine Zeichenfolge handelt, die den Schlüssel des vorherigen Geschwisterkindes durch Sortierreihenfolge enthält, oder null , wenn es das erste Kind ist.

Unterschrift:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Kehrt zurück:

Abbestellen

Eine Funktion, die aufgerufen werden kann, um den Hörer zu entfernen.

onchildremoved (Abfrage, Rückruf, AbbrechenCallback)

Hört auf Datenänderungen an einem bestimmten Ort.

Dies ist die primäre Möglichkeit, Daten aus einer Datenbank zu lesen. Ihr Rückruf wird für die anfänglichen Daten und erneut ausgelöst, wenn sich die Daten ändert. Rufen Sie den zurückgegebenen Rückruf auf, um die Empfang von Updates einzustellen. Weitere Informationen finden Sie im Internet ab .

Ein onChildRemoved -Ereignis wird einmal jedes Mal ausgelöst, wenn ein Kind entfernt wird. Der in den Rückruf übergebene DataSnapshot sind die alten Daten für das Kind, das entfernt wurde. Ein Kind wird entfernt, wenn beide:

• Ein Kunde ruft explizit remove() auf dieses Kind oder einen seiner Vorfahren an - ein Kunde ruft set(null) auf diesem Kind oder einem seiner Vorfahren ein - dass das Kind alle Kinder entfernt hat - es gibt eine Abfrage, die jetzt filtert Aus dem Kind aus (weil es sich verändert hat oder die maximale Grenze getroffen wurde)

Unterschrift:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parameter

Kehrt zurück:

Abbestellen

Eine Funktion, die aufgerufen werden kann, um den Hörer zu entfernen.

onChildRemoved(Abfrage, Rückruf, Optionen)

Hört auf Datenänderungen an einem bestimmten Ort.

Dies ist die primäre Möglichkeit, Daten aus einer Datenbank zu lesen. Ihr Rückruf wird für die anfänglichen Daten und erneut ausgelöst, wenn sich die Daten ändert. Rufen Sie den zurückgegebenen Rückruf auf, um die Empfang von Updates einzustellen. Weitere Informationen finden Sie im Internet ab .

Ein onChildRemoved -Ereignis wird einmal jedes Mal ausgelöst, wenn ein Kind entfernt wird. Der in den Rückruf übergebene DataSnapshot sind die alten Daten für das Kind, das entfernt wurde. Ein Kind wird entfernt, wenn beide:

• Ein Kunde ruft explizit remove() auf dieses Kind oder einen seiner Vorfahren an - ein Kunde ruft set(null) auf diesem Kind oder einem seiner Vorfahren ein - dass das Kind alle Kinder entfernt hat - es gibt eine Abfrage, die jetzt filtert Aus dem Kind aus (weil es sich verändert hat oder die maximale Grenze getroffen wurde)

Unterschrift:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Kehrt zurück:

Abbestellen

Eine Funktion, die aufgerufen werden kann, um den Hörer zu entfernen.

Onchildremoved (Abfrage, Rückruf, AbbrechenCallback, Optionen)

Hört auf Datenänderungen an einem bestimmten Ort.

Dies ist die primäre Möglichkeit, Daten aus einer Datenbank zu lesen. Ihr Rückruf wird für die anfänglichen Daten und erneut ausgelöst, wenn sich die Daten ändert. Rufen Sie den zurückgegebenen Rückruf auf, um die Empfang von Updates einzustellen. Weitere Informationen finden Sie im Internet ab .

Ein onChildRemoved -Ereignis wird einmal jedes Mal ausgelöst, wenn ein Kind entfernt wird. Der in den Rückruf übergebene DataSnapshot sind die alten Daten für das Kind, das entfernt wurde. Ein Kind wird entfernt, wenn beide:

• Ein Kunde ruft explizit remove() auf dieses Kind oder einen seiner Vorfahren an - ein Kunde ruft set(null) auf diesem Kind oder einem seiner Vorfahren ein - dass das Kind alle Kinder entfernt hat - es gibt eine Abfrage, die jetzt filtert Aus dem Kind aus (weil es sich verändert hat oder die maximale Grenze getroffen wurde)

Unterschrift:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Kehrt zurück:

Abbestellen

Eine Funktion, die aufgerufen werden kann, um den Hörer zu entfernen.

Onvalue (Abfrage, Rückruf, AbbrechenCallback)

Hört auf Datenänderungen an einem bestimmten Ort.

Dies ist die primäre Möglichkeit, Daten aus einer Datenbank zu lesen. Ihr Rückruf wird für die anfänglichen Daten und erneut ausgelöst, wenn sich die Daten ändert. Rufen Sie den zurückgegebenen Rückruf auf, um die Empfang von Updates einzustellen. Weitere Informationen finden Sie im Internet ab .

Ein onValue -Ereignis löst einmal mit den an diesem Ort gespeicherten anfänglichen Daten aus und dann jedes Mal erneut, wenn sich die Daten ändert. Der an den Rückruf übergebene DataSnapshot wird für den Ort sein, an dem on() gerufen wurde. Es wird erst ausgelöst, wenn der gesamte Inhalt synchronisiert wurde. Wenn der Standort keine Daten enthält, wird er mit einem leeren DataSnapshot ( null val() ausgelöst ).

Unterschrift:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parameter

Kehrt zurück:

Abbestellen

Eine Funktion, die aufgerufen werden kann, um den Hörer zu entfernen.

Einwert (Abfrage, Rückruf, Optionen)

Hört auf Datenänderungen an einem bestimmten Ort.

Dies ist die primäre Möglichkeit, Daten aus einer Datenbank zu lesen. Ihr Rückruf wird für die anfänglichen Daten und erneut ausgelöst, wenn sich die Daten ändert. Rufen Sie den zurückgegebenen Rückruf auf, um die Empfang von Updates einzustellen. Weitere Informationen finden Sie im Internet ab .

Ein onValue -Ereignis löst einmal mit den an diesem Ort gespeicherten anfänglichen Daten aus und dann jedes Mal erneut, wenn sich die Daten ändert. Der an den Rückruf übergebene DataSnapshot wird für den Ort sein, an dem on() gerufen wurde. Es wird erst ausgelöst, wenn der gesamte Inhalt synchronisiert wurde. Wenn der Standort keine Daten enthält, wird er mit einem leeren DataSnapshot ( null val() ausgelöst ).

Unterschrift:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Kehrt zurück:

Abbestellen

Eine Funktion, die aufgerufen werden kann, um den Hörer zu entfernen.

OnValue (Abfrage, Rückruf, AbbrechenCallback, Optionen)

Hört auf Datenänderungen an einem bestimmten Ort.

Dies ist die primäre Möglichkeit, Daten aus einer Datenbank zu lesen. Ihr Rückruf wird für die anfänglichen Daten und erneut ausgelöst, wenn sich die Daten ändert. Rufen Sie den zurückgegebenen Rückruf auf, um die Empfang von Updates einzustellen. Weitere Informationen finden Sie im Internet ab .

Ein onValue -Ereignis löst einmal mit den an diesem Ort gespeicherten anfänglichen Daten aus und dann jedes Mal erneut, wenn sich die Daten ändert. Der an den Rückruf übergebene DataSnapshot wird für den Ort sein, an dem on() gerufen wurde. Es wird erst ausgelöst, wenn der gesamte Inhalt synchronisiert wurde. Wenn der Standort keine Daten enthält, wird er mit einem leeren DataSnapshot ( null val() ausgelöst ).

Unterschrift:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Kehrt zurück:

Abbestellen

Eine Funktion, die aufgerufen werden kann, um den Hörer zu entfernen.

Abfrage (Abfrage, QueryConstraints)

Erstellt eine neue unveränderliche Query , die erweitert wird, um auch zusätzliche Abfragebeschränkungen zu enthalten.

Unterschrift:

export declare function query(query: Query, ...queryConstraints: QueryConstraint[]): Query;

Parameter

Kehrt zurück:

Abfrage

Ausnahmen

Wenn eines der bereitgestellten Abfragenbeschränkungen nicht mit den vorhandenen oder neuen Einschränkungen kombiniert werden kann.

Funktion(ref, ...)

onDisconnect(ref)

Gibt ein OnDisconnect -Objekt zurück - Weitere Informationen zur Verwendung finden Sie in Offline -Funktionen in JavaScript .

Unterschrift:

export declare function onDisconnect(ref: DatabaseReference): OnDisconnect;

Parameter

Kehrt zurück:

Ondisconnect

entfernen(ref)

Entfernt die Daten an diesem Datenbankort.

Alle Daten an Kindern werden ebenfalls gelöscht.

Der Effekt des Entfernens wird sofort sichtbar und der entsprechende Ereigniswert "Wert" ausgelöst. Die Synchronisation des Entfernens an die Firebase -Server wird ebenfalls gestartet, und das zurückgegebene Versprechen wird nach Abschluss der Abschluss auflösen. Wenn der OnComplete -Rückruf zur Verfügung gestellt wird, wird nach Abschluss der Synchronisation asynchron aufgerufen.

Unterschrift:

export declare function remove(ref: DatabaseReference): Promise<void>;

Parameter

Kehrt zurück:

Versprechen <void>

Auflösungen, wenn das Entfernen auf dem Server abgeschlossen ist.

runTransaction(ref, transactionUpdate, options)

Atomically modifies the data at this location.

Atomically modify the data at this location. Unlike a normal set() , which just overwrites the data regardless of its previous value, runTransaction() is used to modify the existing value to a new value, ensuring there are no conflicts with other clients writing to the same location at the same time.

To accomplish this, you pass runTransaction() an update function which is used to transform the current value into a new value. If another client writes to the location before your new value is successfully written, your update function will be called again with the new current value, and the write will be retried. This will happen repeatedly until your write succeeds without conflict or you abort the transaction by not returning a value from your update function.

Unterschrift:

export declare function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;

Parameter

Kehrt zurück:

Promise< TransactionResult >

A Promise that can optionally be used instead of the onComplete callback to handle success and failure.

set(ref, value)

Writes data to this Database location.

This will overwrite any data at this location and all child locations.

The effect of the write will be visible immediately, and the corresponding events ("value", "child_added", etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

Passing null for the new value is equivalent to calling remove() ; namely, all data at this location and all child locations will be deleted.

set() will remove any priority stored at this location, so if priority is meant to be preserved, you need to use setWithPriority() instead.

Note that modifying data with set() will cancel any pending transactions at that location, so extreme care should be taken if mixing set() and transaction() to modify the same data.

A single set() will generate a single "value" event at the location where the set() was performed.

Unterschrift:

export declare function set(ref: DatabaseReference, value: unknown): Promise<void>;

Parameter

Kehrt zurück:

Promise<void>

Resolves when write to server is complete.

setPriority(ref, priority)

Sets a priority for the data at this Database location.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

Unterschrift:

export declare function setPriority(ref: DatabaseReference, priority: string | number | null): Promise<void>;

Parameter

Kehrt zurück:

Promise<void>

Resolves when write to server is complete.

setWithPriority(ref, value, priority)

Writes data the Database location. Like set() but also specifies the priority for that data.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

Unterschrift:

export declare function setWithPriority(ref: DatabaseReference, value: unknown, priority: string | number | null): Promise<void>;

Parameter

Kehrt zurück:

Promise<void>

Resolves when write to server is complete.

update(ref, Werte)

Writes multiple values to the Database at once.

The values argument contains multiple property-value pairs that will be written to the Database together. Each child property can either be a simple property (for example, "name") or a relative path (for example, "name/first") from the current location to the data to update.

As opposed to the set() method, update() can be use to selectively update only the referenced properties at the current location (instead of replacing all the child properties at the current location).

The effect of the write will be visible immediately, and the corresponding events ('value', 'child_added', etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

A single update() will generate a single "value" event at the location where the update() was performed, regardless of how many children were modified.

Note that modifying data with update() will cancel any pending transactions at that location, so extreme care should be taken if mixing update() and transaction() to modify the same data.

Passing null to update() will remove the data at this location.

See Introducing multi-location updates and more .

Unterschrift:

export declare function update(ref: DatabaseReference, values: object): Promise<void>;

Parameter

Kehrt zurück:

Promise<void>

Resolves when update on server is complete.

Funktion(Wert, ...)

endAt(value, key)

Creates a QueryConstraint with the specified ending point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name less than or equal to the specified key.

You can read more about endAt() in Filtering data .

Unterschrift:

export declare function endAt(value: number | string | boolean | null, key?: string): QueryConstraint;

Parameter

Kehrt zurück:

QueryConstraint

endBefore(Wert, Schlüssel)

Creates a QueryConstraint with the specified ending point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is exclusive. If only a value is provided, children with a value less than the specified value will be included in the query. If a key is specified, then children must have a value less than or equal to the specified value and a key name less than the specified key.

Unterschrift:

export declare function endBefore(value: number | string | boolean | null, key?: string): QueryConstraint;

Parameter

Kehrt zurück:

QueryConstraint

equalTo(value, key)

Creates a QueryConstraint that includes children that match the specified value.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have exactly the specified key as their key name. This can be used to filter result sets with many matches for the same value.

You can read more about equalTo() in Filtering data .

Unterschrift:

export declare function equalTo(value: number | string | boolean | null, key?: string): QueryConstraint;

Parameter

Kehrt zurück:

QueryConstraint

startAfter(value, key)

Creates a QueryConstraint with the specified starting point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is exclusive. If only a value is provided, children with a value greater than the specified value will be included in the query. If a key is specified, then children must have a value greater than or equal to the specified value and aa key name greater than the specified key.

Unterschrift:

export declare function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;

Parameter

Kehrt zurück:

QueryConstraint

startAt(value, key)

Creates a QueryConstraint with the specified starting point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name greater than or equal to the specified key.

You can read more about startAt() in Filtering data .

Unterschrift:

export declare function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;

Parameter

Kehrt zurück:

QueryConstraint

EventType

One of the following strings: "value", "child_added", "child_changed", "child_removed", or "child_moved."

Unterschrift:

export declare type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';

QueryConstraintType

Describes the different query constraints available in this SDK.

Unterschrift:

export declare type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';

Abbestellen

A callback that can invoked to remove a listener.

Unterschrift:

export declare type Unsubscribe = () => void;