database.DataSnapshot class

Schnittstelle, die einen Daten-Snapshot einer Firebase Realtime-Datenbank darstellt.

Unterschrift:

export declare class DataSnapshot implements database.DataSnapshot 

Implementiert: Datenbank.DataSnapshot

Konstrukteure

Eigenschaften

Methoden

Datenbank.DataSnapshot.(Konstruktor)

Konstruiert eine neue Instanz der DataSnapshot Klasse

Unterschrift:

constructor(data: any, path?: string, // path is undefined for the database root
    app?: App, instance?: string);

Parameter

Datenbank.DataSnapshot.instance

Unterschrift:

instance: string;

Datenbank.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/ . Beim Zugriff auf den Schlüssel in einem beliebigen DataSnapshot wird der Schlüssel für den Speicherort zurückgegeben, der ihn generiert hat. Der Zugriff auf den Schlüssel über die Stamm-URL einer Datenbank gibt jedoch null zurück .

Unterschrift:

get key(): string | null;

Datenbank.DataSnapshot.ref

Gibt eine [ Reference zurück ](/docs/reference/admin/node/admin.database.Reference) zum Datenbankspeicherort, an dem der auslösende Schreibvorgang stattgefunden hat. Hat vollen Lese- und Schreibzugriff.

Unterschrift:

get ref(): database.Reference;

Datenbank.DataSnapshot.child()

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

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.

Unterschrift:

child(childPath: string): DataSnapshot;

Parameter

Kehrt zurück:

Datenschnappschuss

Datenbank.DataSnapshot.exists()

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

true , wenn dieser DataSnapshot Daten enthält; andernfalls false .

Unterschrift:

exists(): boolean;

Kehrt zurück:

Boolescher Wert

Datenbank.DataSnapshot.exportVal()

Exportiert den gesamten Inhalt des DataSnapshot als JavaScript-Objekt.

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

Unterschrift:

exportVal(): any;

Kehrt zurück:

beliebig

Datenbank.DataSnapshot.forEach()

Listet den DataSnapshot auf s der Kinderelemente.

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 von child_added Ereignissen übereinstimmt. Hier kommt forEach() zum Einsatz. Es garantiert, dass die untergeordneten Elemente eines DataSnapshot in ihrer Abfragereihenfolge iteriert werden können.

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: (a: IteratedDataSnapshot) => boolean | void): boolean;

Parameter

Kehrt zurück:

Boolescher Wert

Datenbank.DataSnapshot.getPriority()

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

Als Alternative zur Verwendung der Priorität können Anwendungen Sammlungen nach gewöhnlichen Eigenschaften ordnen. Siehe [Daten sortieren und filtern](/docs/database/web/lists-of-data#sorting_and_filtering_data).

Der Prioritätswert der Daten.

Unterschrift:

getPriority(): string | number | null;

Kehrt zurück:

Zeichenfolge | Nummer | Null

Datenbank.DataSnapshot.hasChild()

Gibt true zurück, wenn der angegebene untergeordnete Pfad (nicht null hat ) Daten.

Unterschrift:

hasChild(childPath: string): boolean;

Parameter

Kehrt zurück:

Boolescher Wert

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

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

Unterschrift:

hasChildren(): boolean;

Kehrt zurück:

Boolescher Wert

Datenbank.DataSnapshot.numChildren()

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

Anzahl der untergeordneten Eigenschaften dieses DataSnapshot .

Unterschrift:

numChildren(): number;

Kehrt zurück:

Nummer

Datenbank.DataSnapshot.toJSON()

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

Eine JSON-serialisierbare Darstellung dieses Objekts.

Unterschrift:

toJSON(): Record<string, unknown>;

Kehrt zurück:

Record<string, unbekannt>

Datenbank.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ückgegeben werden , was anzeigt, dass der DataSnapshot leer ist (keine Daten enthält).

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

Unterschrift:

val(): any;

Kehrt zurück:

beliebig