DataSnapshot class

Ein DataSnapshot enthält Daten von einem Datenbankspeicherort.

Jedes Mal, wenn Sie Daten aus der Datenbank lesen, erhalten Sie die Daten als DataSnapshot . Ein DataSnapshot wird an die Ereignisrückrufe übergeben, die Sie mit on() oder once() anhängen. . Sie können den Inhalt des Snapshots als JavaScript-Objekt extrahieren, indem Sie die Methode val() aufrufen. Alternativ können Sie in den Snapshot wechseln, indem Sie child() aufrufen, um untergeordnete Snapshots zurückzugeben (für die Sie dann val() aufrufen können).

Ein DataSnapshot ist eine effizient generierte, unveränderliche Kopie der Daten an einem Datenbankstandort. Es kann nicht geändert werden und wird sich nie ändern (um Daten zu ändern, rufen Sie immer direkt die set() Methode einer Reference auf).

Unterschrift:

export declare class DataSnapshot 

Eigenschaften

Methoden

DataSnapshot.key

Der Schlüssel (letzter Teil des Pfads) des Speicherorts dieses DataSnapshot .

Das letzte Token an einem Datenbankstandort wird als dessen Schlüssel betrachtet. „ada“ ist beispielsweise der Schlüssel für den Knoten /users/ada/. Wenn Sie in einem beliebigen DataSnapshot auf den Schlüssel zugreifen, wird der Schlüssel für den Speicherort zurückgegeben, der ihn generiert hat. Beim Zugriff auf den Schlüssel über die Stamm-URL einer Datenbank wird jedoch null zurückgegeben .

Unterschrift:

get key(): string | null;

DataSnapshot.priority

Ruft den Prioritätswert der Daten in diesem DataSnapshot ab .

Anwendungen müssen keine Priorität verwenden, sondern können Sammlungen nach gewöhnlichen Eigenschaften ordnen (siehe Sortieren und Filtern von Daten ).

Unterschrift:

get priority(): string | number | null;

DataSnapshot.ref

Der Speicherort dieses DataSnapshot.

Unterschrift:

readonly ref: DatabaseReference;

DataSnapshot.size

Gibt die Anzahl der untergeordneten Eigenschaften dieses DataSnapshot zurück .

Unterschrift:

get size(): number;

DataSnapshot.child()

Ruft einen weiteren DataSnapshot für den Speicherort am angegebenen relativen Pfad ab.

Die Übergabe eines relativen Pfads an die Methode child() eines DataSnapshot gibt einen weiteren DataSnapshot für den Speicherort am angegebenen relativen Pfad zurück. Der relative Pfad kann entweder ein einfacher untergeordneter Name (z. B. „ada“) oder ein tieferer, durch Schrägstriche getrennter Pfad (z. B. „ada/name/first“) sein. Wenn der untergeordnete Speicherort keine Daten enthält, wird ein leerer DataSnapshot (d. h. ein DataSnapshot , dessen Wert null ist) angezeigt ) ist zurück gekommen.

Unterschrift:

child(path: string): DataSnapshot;

Parameter

Kehrt zurück:

Datenschnappschuss

DataSnapshot.exists()

Gibt „true“ zurück, wenn dieser DataSnapshot Daten enthält. Es ist etwas effizienter als die Verwendung von snapshot.val() !== null .

Unterschrift:

exists(): boolean;

Kehrt zurück:

Boolescher Wert

DataSnapshot.exportVal()

Exportiert den gesamten Inhalt des DataSnapshot als JavaScript-Objekt.

Die Methode exportVal() ähnelt val() , außer dass Prioritätsinformationen enthalten sind (falls verfügbar), sodass sie für die Sicherung Ihrer Daten geeignet sind.

Unterschrift:

exportVal(): any;

Kehrt zurück:

beliebig

Der Inhalt des DataSnapshot als JavaScript-Wert (Objekt, Array, Zeichenfolge, Zahl, boolescher Wert oder null ).

DataSnapshot.forEach()

Listet die untergeordneten Elemente der obersten Ebene im IteratedDataSnapshot auf .

Aufgrund der Funktionsweise von JavaScript-Objekten kann nicht garantiert werden, dass die Reihenfolge der Daten im von val() zurückgegebenen JavaScript-Objekt mit der Reihenfolge auf dem Server oder der Reihenfolge der onChildAdded() Ereignisse übereinstimmt. Hier kommt forEach() zum Einsatz. Es garantiert, dass die untergeordneten Elemente eines DataSnapshot in ihrer Abfragereihenfolge iteriert werden.

Wenn keine explizite orderBy*() Methode verwendet wird, werden die Ergebnisse nach Schlüssel sortiert zurückgegeben (es sei denn, es werden Prioritäten verwendet; in diesem Fall werden die Ergebnisse nach Priorität zurückgegeben).

Unterschrift:

forEach(action: (child: IteratedDataSnapshot) => boolean | void): boolean;

Parameter

Kehrt zurück:

Boolescher Wert

true, wenn die Aufzählung abgebrochen wurde, weil Ihr Rückruf true zurückgegeben hat.

DataSnapshot.hasChild()

Gibt „true“ zurück, wenn der angegebene untergeordnete Pfad Daten (nicht Null) enthält.

Unterschrift:

hasChild(path: string): boolean;

Parameter

Kehrt zurück:

Boolescher Wert

true , wenn Daten im angegebenen untergeordneten Pfad vorhanden sind; sonst false .

DataSnapshot.hasChildren()

Gibt zurück, ob der DataSnapshot über untergeordnete Eigenschaften ungleich null verfügt.

Sie können hasChildren() verwenden, um festzustellen, ob ein DataSnapshot untergeordnete Elemente hat. Wenn dies der Fall ist, können Sie sie mit forEach() aufzählen. . Wenn dies nicht der Fall ist, enthält dieser Snapshot entweder einen primitiven Wert (der mit val() ) oder es ist leer (in diesem Fall gibt val() null zurück ).

Unterschrift:

hasChildren(): boolean;

Kehrt zurück:

Boolescher Wert

true, wenn dieser Snapshot untergeordnete Elemente hat; sonst falsch.

DataSnapshot.toJSON()

Gibt eine JSON-serialisierbare Darstellung dieses Objekts zurück.

Unterschrift:

toJSON(): object | null;

Kehrt zurück:

Objekt | Null

DataSnapshot.val()

Extrahiert einen JavaScript-Wert aus einem DataSnapshot .

Abhängig von den Daten in einem DataSnapshot , kann die val() -Methode einen Skalartyp (Zeichenfolge, Zahl oder boolescher Wert), ein Array oder ein Objekt zurückgeben. Es kann auch Null zurückgeben, was darauf hinweist, dass der DataSnapshot leer ist (keine Daten enthält).

Unterschrift:

val(): any;

Kehrt zurück:

beliebig

Der Inhalt des DataSnapshot als JavaScript-Wert (Objekt, Array, Zeichenfolge, Zahl, Boolescher Wert oder null ).