database.DataSnapshot class

Interfejs przedstawiający zrzut danych w bazie danych Firebase w czasie rzeczywistym.

Podpis:

export declare class DataSnapshot implements database.DataSnapshot

Implementacje: database.DataSnapshot

Zespoły

Zespół Modyfikatory Opis
(konstruktor)(dane; ścieżka, aplikacja; instancja) Tworzy nową instancję klasy DataSnapshot

Właściwości

Właściwość Modyfikatory Typ Opis
instance, ciąg znaków
klucz ciąg znaków | wartość null Klucz (ostatnia część ścieżki) lokalizacji tego elementu (DataSnapshot).Ostatnim tokenem w lokalizacji bazy danych jest jego klucz. Na przykład „ada” jest kluczem węzła /users/ada/. Dostęp do klucza na dowolnym urządzeniu DataSnapshot powoduje zwrócenie klucza lokalizacji, w której został wygenerowany. Jednak dostęp do klucza z głównego adresu URL bazy danych zwraca null.
źródło baza danych.Odniesienie Zwraca [Reference](/docs/reference/admin/node/admin.database.Reference) do lokalizacji bazy danych, w której nastąpił zapis aktywujący. Ma pełne uprawnienia do odczytu i zapisu.

Metody

Metoda Modyfikatory Opis
child(childPath) Pobiera DataSnapshot dla lokalizacji w określonej ścieżce względnej.Ścieżka względna może być prostą nazwą podrzędną (np. „ada”) lub ścieżką oddzielonych ukośnikami (np. „ada/name/first”).
exists() Zwraca true, jeśli ten element DataSnapshot zawiera jakiekolwiek dane. To działanie trochę wydajniejsze niż snapshot.val() !== null. true, jeśli ten element DataSnapshot zawiera jakiekolwiek dane; w przeciwnym razie: false.
exportVal() Eksportuje całą zawartość obiektu DataSnapshot jako obiekt JavaScript. Zawartość pola DataSnapshot jako wartości JavaScript (obiekt, tablica, ciąg, liczba, wartość logiczna lub null).
forEach(działanie) Wylicza DataSnapshot elementów podrzędnych.Ze względu na sposób działania obiektów JavaScript kolejność danych w obiekcie JavaScript zwracanym przez funkcję val() nie musi być zgodna z kolejnością na serwerze ani kolejności zdarzeń child_added. Z pomocą przyda się forEach(). Gwarantuje, że elementy podrzędne elementu DataSnapshot mogą zostać wykonane w kolejności zapytań.Jeśli nie użyto żadnej jawnej metody orderBy*(), wyniki są zwracane w kolejności uporządkowanej według klucza (chyba że używane są priorytety – w takim przypadku wyniki są zwracane według priorytetu).
getPriority(), Pobiera wartość priorytetu danych w zasobniku DataSnapshot.Zamiast używać priorytetu, aplikacje mogą grupować kolekcje według właściwości zwykłych. Zobacz [Sortowanie i filtrowanie danych](/docs/database/web/lists-of-data#sorting_and_filtering_data). Wartość priorytetu danych.
hasChild(childPath) Zwraca true, jeśli podana ścieżka podrzędna zawiera dane (inne niż null).
hasChildren() Zwraca, czy DataSnapshot ma jakiekolwiek właściwości podrzędne inne niż null.Za pomocą hasChildren() możesz określić, czy obiekt DataSnapshot ma jakiekolwiek właściwości podrzędne. Jeśli tak, możesz je wyliczyć za pomocą funkcji forEach(). Jeśli tak nie jest, zrzut dysku zawiera wartość podstawową (którą można pobrać przy użyciu funkcji val()) lub jest on pusty (w takim przypadku val() zwraca wartość null). true, jeśli ten zrzut ma elementy podrzędne; a w przypadku: false.
numChildren() Zwraca liczbę właściwości podrzędnych obiektu DataSnapshot. Liczba właściwości podrzędnych obiektu DataSnapshot.
toJSON(), Zwraca możliwą do serializowania reprezentację tego obiektu w formacie JSON. Możliwa do serializowania reprezentacja tego obiektu w formacie JSON.
val(), Wyodrębnia wartość JavaScript z DataSnapshot.W zależności od danych w DataSnapshot metoda val() może zwrócić typ skalarny (ciąg znaków, liczba lub wartość logiczna), tablicę lub obiekt. Może też zwrócić wartość null, co oznacza, że pole DataSnapshot jest puste (nie zawiera danych). Zawartość zrzutu jako wartość JavaScript (obiekt, tablica, ciąg, liczba, wartość logiczna lub null).

resource.DataSnapshot.(konstruktor)

Tworzy nową instancję klasy DataSnapshot

Podpis:

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

Parametry

Parametr Typ Opis
dane dowolny
ścieżka ciąg znaków
aplikacja Aplikacja
instancja ciąg znaków

baza_danych.DataSnapshot.instance

Podpis:

instance: string;

baza_danych.DataSnapshot.key

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

Ostatni token w lokalizacji bazy danych jest traktowany jako jego klucz. Na przykład „ada” jest kluczem węzła /users/ada/. Dostęp do klucza na dowolnym urządzeniu DataSnapshot zwraca klucz do lokalizacji, w której został wygenerowany. Jednak dostęp do klucza z głównego adresu URL bazy danych zwraca null.

Podpis:

get key(): string | null;

bazy danych.DataSnapshot.ref

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

Podpis:

get ref(): database.Reference;

database.DataSnapshot.child()

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

Ścieżka względna może być prostą nazwą podrzędną (np. „ada”) lub głębszą ścieżką oddzielonych ukośnikami (np. „ada/nazwa/imię”).

Podpis:

child(childPath: string): DataSnapshot;

Parametry

Parametr Typ Opis
ścieżka podrzędna ciąg znaków

Zwroty:

DataSnapshot

resource.DataSnapshot.exists(),

Zwraca true, jeśli ten element DataSnapshot zawiera jakiekolwiek dane. To trochę wydajniejsza metoda niż snapshot.val() !== null.

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

Podpis:

exists(): boolean;

Zwroty:

wartość logiczna

resource.DataSnapshot.exportVal()

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

Zawartość pola DataSnapshot jako wartości JavaScript (obiekt, tablica, ciąg, liczba, wartość logiczna lub null).

Podpis:

exportVal(): any;

Zwroty:

dowolny

resource.DataSnapshot.forEach(),

Wylicza DataSnapshot elementów podrzędnych.

Ze względu na sposób działania obiektów JavaScript kolejność danych w obiekcie JavaScript zwracanym przez funkcję val() nie musi być zgodna z kolejnością na serwerze ani zdarzeń child_added. Z pomocą przyda się forEach(). Gwarantuje, że elementy podrzędne elementu DataSnapshot mogą być powtórzone w kolejności zapytań.

Jeśli nie jest używana jawna metoda orderBy*(), wyniki są zwracane w kolejności według klucza (chyba że są używane priorytety – wtedy wyniki są zwracane według priorytetu).

Podpis:

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

Parametry

Parametr Typ Opis
działanie (a: DataSnapshot) => boolean | nieważne Funkcja, która jest wywoływana dla każdego elementu podrzędnego DataSnapshot. Wywołanie zwrotne może zwrócić wartość true, aby anulować kolejne wyliczanie. true, jeśli wyliczenie zostało anulowane z powodu wywołania zwrotnego zwracającego true.

Zwroty:

wartość logiczna

resource.DataSnapshot.getPriority():

Pobiera wartość priorytetu danych w: DataSnapshot.

Zamiast używać priorytetu, aplikacje mogą grupować zbiory według właściwości zwykłych. 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 znaków | liczba | wartość null

resource.DataSnapshot.hasChild()

Zwraca true, jeśli podana ścieżka podrzędna zawiera dane (inne niż null).

Podpis:

hasChild(childPath: string): boolean;

Parametry

Parametr Typ Opis
ścieżka podrzędna ciąg znaków

Zwroty:

wartość logiczna

resource.DataSnapshot.hasChildren()

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

Aby określić, czy element DataSnapshot ma dzieci, możesz użyć hasChildren(). Jeśli tak, możesz je wyliczyć za pomocą funkcji forEach(). Jeśli tak nie jest, zrzut ten zawiera wartość podstawową (którą można pobrać przy użyciu funkcji val()) lub jest on pusty (w takim przypadku val() zwraca null).

true, jeśli ten zrzut ma elementy podrzędne; w przeciwnym razie false.

Podpis:

hasChildren(): boolean;

Zwroty:

wartość logiczna

database.DataSnapshot.numChildren()

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

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

Podpis:

numChildren(): number;

Zwroty:

liczba

resource.DataSnapshot.toJSON()

Zwraca możliwą do serializowania reprezentację tego obiektu w formacie JSON.

Możliwa do serializowania reprezentacja tego obiektu w formacie JSON.

Podpis:

toJSON(): Record<string, unknown>;

Zwroty:

Rekord<ciąg, nieznany>

bazy danych.DataSnapshot.val()

Wyodrębnia wartość JavaScript z: DataSnapshot.

W zależności od danych w DataSnapshot metoda val() może zwracać typ skalarny (ciąg znaków, liczba lub wartość logiczna), tablicę lub obiekt. Może też zwrócić wartość null, co oznacza, że pole DataSnapshot jest puste (nie zawiera danych).

Zawartość zrzutu jako wartość JavaScript (obiekt, tablica, ciąg, liczba, wartość logiczna lub null).

Podpis:

val(): any;

Zwroty:

dowolny