database.DataSnapshot class

Interfejs reprezentujący migawkę danych bazy danych Firebase Realtime.

Podpis:

export declare class DataSnapshot implements database.DataSnapshot 

Implementuje: bazę danych.DataSnapshot

Konstruktorzy

Nieruchomości

Metody

baza danych.DataSnapshot.(konstruktor)

Konstruuje nową instancję klasy DataSnapshot

Podpis:

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

Parametry

baza danych.DataSnapshot.instancja

Podpis:

instance: string;

baza danych.DataSnapshot.key

Klucz (ostatnia część ścieżki) lokalizacji tego DataSnapshot .

Ostatni token w lokalizacji bazy danych jest uważany za jej klucz. Na przykład „ada” jest kluczem dla węzła /users/ada/ . Dostęp do klucza w dowolnym DataSnapshot zwraca klucz dla lokalizacji, która go wygenerowała. Jednak dostęp do klucza w głównym adresie URL bazy danych zwraca wartość null .

Podpis:

get key(): string | null;

baza danych.DataSnapshot.ref

Zwraca [ Reference ](/docs/reference/admin/node/admin.database.Reference) do lokalizacji bazy danych, w której nastąpił zapis wyzwalający. Ma pełny dostęp do odczytu i zapisu.

Podpis:

get ref(): database.Reference;

baza danych.DataSnapshot.child()

Pobiera DataSnapshot dla lokalizacji w określonej ścieżce względnej.

Ścieżka względna może być prostą nazwą podrzędną (na przykład „ada”) lub głębszą ścieżką oddzieloną ukośnikiem (na przykład „ada/imię/pierwszy”).

Podpis:

child(childPath: string): DataSnapshot;

Parametry

Zwroty:

Migawka danych

baza danych.DataSnapshot.exists()

Zwraca wartość true , jeśli ten DataSnapshot zawiera jakiekolwiek dane. Jest to nieco bardziej wydajne niż użycie snapshot.val() !== null .

true , jeśli ten DataSnapshot zawiera jakiekolwiek dane; w przeciwnym razie false .

Podpis:

exists(): boolean;

Zwroty:

wartość logiczna

baza danych.DataSnapshot.exportVal()

Eksportuje całą zawartość DataSnapshot jako obiekt JavaScript.

Zawartość DataSnapshot jako wartość JavaScript (Object, Array, string, number, boolean lub null ).

Podpis:

exportVal(): any;

Zwroty:

każdy

baza danych.DataSnapshot.forEach()

Wylicza DataSnapshot elementów dla dzieci.

Ze względu na sposób działania obiektów JavaScript, nie ma gwarancji, że kolejność danych w obiekcie JavaScript zwrócona przez val() będzie zgodna z kolejnością na serwerze ani kolejnością zdarzeń child_added . W tym miejscu przydaje się funkcja forEach() . Gwarantuje to, że dzieci DataSnapshot mogą być iterowane w kolejności zapytań.

Jeśli nie została użyta żadna jawna metoda orderBy*() , wyniki są zwracane według klucza (chyba że zastosowano priorytety, w takim przypadku wyniki są zwracane według priorytetów).

Podpis:

forEach(action: (a: DataSnapshot) => boolean | void): boolean;

Parametry

Zwroty:

wartość logiczna

baza danych.DataSnapshot.getPriority()

Pobiera wartość priorytetu danych w tym DataSnapshot .

Alternatywą dla korzystania z priorytetu jest możliwość porządkowania kolekcji według zwykłych właściwości. Zobacz [Sortowanie i filtrowanie danych](/docs/database/web/lists-of-data#sorting_and_filtering_data).

Wartość priorytetu danych.

Podpis:

getPriority(): string | number | null;

Zwroty:

ciąg | numer | zero

baza danych.DataSnapshot.hasChild()

Zwraca wartość true , jeśli określona ścieżka podrzędna ma (inną niż null ) dane.

Podpis:

hasChild(childPath: string): boolean;

Parametry

Zwroty:

wartość logiczna

baza danych.DataSnapshot.hasChildren()

Zwraca informację, czy DataSnapshot ma właściwości podrzędne inne niż null .

Możesz użyć hasChildren() , aby określić, czy DataSnapshot ma jakieś dzieci. Jeśli tak, możesz je wyliczyć za pomocą forEach() . Jeśli tak nie jest, to albo ta migawka zawiera wartość pierwotną (którą można pobrać za pomocą val() ) lub jest pusta (w takim przypadku val() zwraca null ).

true Jeśli ta migawka ma jakieś elementy podrzędne; inaczej false .

Podpis:

hasChildren(): boolean;

Zwroty:

wartość logiczna

baza danych.DataSnapshot.numChildren()

Zwraca liczbę właściwości podrzędnych tego DataSnapshot .

Liczba właściwości podrzędnych tego DataSnapshot .

Podpis:

numChildren(): number;

Zwroty:

numer

baza danych.DataSnapshot.toJSON()

Zwraca reprezentację tego obiektu nadającą się do serializacji w formacie JSON.

Reprezentacja tego obiektu możliwa do serializacji w formacie JSON.

Podpis:

toJSON(): Record<string, unknown>;

Zwroty:

Rekord<ciąg, nieznany>

baza danych.DataSnapshot.val()

Wyodrębnia wartość JavaScript z DataSnapshot .

W zależności od danych w DataSnapshot , metoda val() może zwrócić typ skalarny (string, liczba lub wartość logiczna), tablicę lub obiekt. Może również zwrócić null , wskazując, że DataSnapshot jest pusty (nie zawiera żadnych danych).

Zawartość migawki jako wartość JavaScript (obiekt, tablica, ciąg znaków, liczba, wartość logiczna lub null ).

Podpis:

val(): any;

Zwroty:

każdy