database package

Baza danych czasu rzeczywistego Firebase

Funkcje

Zajęcia

Interfejsy

Wpisz aliasy

funkcja (aplikacja, ...)

getDatabase(aplikacja, adres URL)

Zwraca instancję zestawu SDK bazy danych czasu rzeczywistego, która jest powiązana z dostarczoną aplikacją FirebaseApp . Inicjuje nową instancję z ustawieniami domyślnymi, jeśli żadna instancja nie istnieje lub jeśli istniejąca instancja używa niestandardowego adresu URL bazy danych.

Podpis:

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

Parametry

Zwroty:

Baza danych

Instancja Database dostarczonej aplikacji.

funkcja (db, ...)

ConnectDatabaseemulator (DB, host, port, opcje)

Zmodyfikuj dostarczoną instancję, aby komunikować się z emulatorem bazy danych w czasie rzeczywistym.

Uwaga: Ta metoda należy wywołać przed wykonaniem jakiejkolwiek innej operacji.

Podpis:

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

Parametry

Zwroty:

próżnia

Gooffline (DB)

Odłącza się od serwera (wszystkie operacje bazy danych zostaną zakończone offline).

Klient automatycznie utrzymuje trwałe połączenie z serwerem bazy danych, który pozostanie aktywny w nieskończoność i ponownie się łączy po odłączeniu. Jednak metody goOffline() i goOnline() mogą być użyte do kontrolowania połączenia klienta w przypadkach, gdy trwałe połączenie jest niepożądane.

Podczas offline klient nie będzie już odbierać aktualizacji danych z bazy danych. Jednak wszystkie operacje bazy danych wykonywane lokalnie będą nadal natychmiast strzelać, umożliwiając normalne zachowanie aplikacji. Dodatkowo każda operacja wykonywana lokalnie będzie automatycznie w kolejce i ponowne ponowne połączenie z serwerem bazy danych.

Aby ponownie połączyć się z bazą danych i rozpocząć odbieranie zdalnych zdarzeń, patrz goOnline() .

Podpis:

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

Parametry

Zwroty:

próżnia

Goonline (DB)

Ponowne połączenie z serwerem i synchronizuje stan bazy danych offline ze stanem serwera.

Tę metodę należy zastosować po wyłączeniu aktywnego połączenia z goOffline() . Po ponownym połączeniu klient przesyła odpowiednie dane i wystrzeliwuje odpowiednie zdarzenia, aby klient „dogania” „dogania”.

Podpis:

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

Parametry

Zwroty:

próżnia

Ref (db, ścieżka)

Zwraca Reference reprezentujące lokalizację w bazie danych odpowiadającej dostarczonej ścieżce. Jeśli nie zostanie podana ścieżka, Reference wskazuje na źródło bazy danych.

Podpis:

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

Parametry

Zwroty:

DatabaseReference

Jeśli podano ścieżkę, Reference wskazujące na dostarczoną ścieżkę. W przeciwnym razie Reference wskazujące na pierwiastek bazy danych.

Reffromurl (DB, URL)

Zwraca Reference reprezentującą lokalizację w bazie danych odpowiadającej dostarczonym adresie URL Firebase.

Wyjątek jest rzucany, jeśli adres URL nie jest prawidłowym adresem URL bazy danych Firebase lub ma inną domenę niż bieżąca instancja Database .

Zauważ, że wszystkie parametry zapytania ( orderBy , limitToLast , itp.) są ignorowane i nie są stosowane do zwróconego Reference .

Podpis:

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

Parametry

Zwroty:

DatabaseReference

Reference wskazujące na dostarczony adres URL bazy ogniowej.

funkcjonować()

ForcelongPolling ()

Wymień użycie Longpolling zamiast koktajli. Zostanie to zignorowane, jeśli protokół WebSocket zostanie użyty w DatabaseURL.

Podpis:

export declare function forceLongPolling(): void;

Zwroty:

próżnia

ForceWebSockets ()

Wymień użycie WebSockets zamiast Longpolling.

Podpis:

export declare function forceWebSockets(): void;

Zwroty:

próżnia

OrderByey ()

Tworzy nowy QueryConstraint , który rozkazuje według klucza.

Sortuje wyniki zapytania według ich (wznoszących się) kluczowych wartości.

Możesz przeczytać więcej o danych orderByKey() .

Podpis:

export declare function orderByKey(): QueryConstraint;

Zwroty:

QueryConstraint

OrderbyPriority ()

Tworzy nowy QueryConstraint , który nakazuje priorytetowo.

Aplikacje nie muszą używać priorytetu, ale mogą zamówić kolekcje według zwykłych właściwości (patrz dane sortowania dla alternatyw dla priorytetu.

Podpis:

export declare function orderByPriority(): QueryConstraint;

Zwroty:

QueryConstraint

orderbyValue ()

Tworzy nowe QueryConstraint , które zamówi według wartości.

Jeśli dzieci zapytania to wszystkie wartości skalarne (ciąg, liczba lub boolean), możesz zamówić wyniki według ich wartości (wznoszących się).

Możesz przeczytać więcej o danych orderByValue() .

Podpis:

export declare function orderByValue(): QueryConstraint;

Zwroty:

QueryConstraint

servertimestamp ()

Zwraca wartość symboliczną do automatycznego populacji bieżącego znacznika czasu (czas od Epochu UNIX, w milisekundach), zgodnie z serwerami bazy Fire Base.

Podpis:

export declare function serverTimestamp(): object;

Zwroty:

obiekt

funkcja (Delta, ...)

Przyrost (Delta)

Zwraca wartość symboliczną, którą można wykorzystać do atomowego zwiększania bieżącej wartości bazy danych przez dostarczoną deltę.

Podpis:

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

Parametry

Zwroty:

obiekt

Wartość zastępcza do modyfikowania danych atomowo po stronie serwera.

funkcja (włączona, ...)

EnableLogging (włączone, trwałe)

Dzienniki debugują informacje do konsoli.

Podpis:

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

Parametry

Zwroty:

każdy

funkcja (limit, ...)

limittoFirst (limit)

Tworzy nowy QueryConstraint , który jest ograniczony do pierwszej konkretnej liczby dzieci.

Metoda limitToFirst() służy do ustawiania maksymalnej liczby dzieci do synchronizacji dla danego zwrotu oddzwonienia. Jeśli ustalimy limit 100, początkowo otrzymamy tylko do 100 wydarzeń child_added . Jeśli w naszej bazie danych przechowywamy mniej niż 100 wiadomości, zdarzenie child_added wystrzeli dla każdej wiadomości. Jeśli jednak będziemy mieli ponad 100 wiadomości, otrzymamy tylko zdarzenie child_added dla pierwszych 100 uporządkowanych wiadomości. Wraz ze zmianą pozycji otrzymamy zdarzenia child_removed dla każdego elementu, który spadnie z aktywnej listy, aby całkowita liczba pozostała na 100.

Możesz przeczytać więcej o limitToFirst() w filtrowaniu danych .

Podpis:

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

Parametry

Zwroty:

QueryConstraint

limitolast (limit)

Tworzy nowy QueryConstraint , który ogranicza się do zwrotu tylko ostatniej określonej liczby dzieci.

Metoda limitToLast() służy do ustawiania maksymalnej liczby dzieci do synchronizacji dla danego zwrotu oddzwonienia. Jeśli ustalimy limit 100, początkowo otrzymamy tylko do 100 wydarzeń child_added . Jeśli w naszej bazie danych przechowywamy mniej niż 100 wiadomości, zdarzenie child_added wystrzeli dla każdej wiadomości. Jeśli jednak mamy ponad 100 wiadomości, otrzymamy tylko zdarzenie child_added dla ostatnich 100 uporządkowanych wiadomości. Wraz ze zmianą pozycji otrzymamy zdarzenia child_removed dla każdego elementu, który spadnie z aktywnej listy, aby całkowita liczba pozostała na 100.

Możesz przeczytać więcej o limitToLast() w filtrowaniu danych .

Podpis:

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

Parametry

Zwroty:

QueryConstraint

funkcja (logger, ...)

EnableLogging (logger)

Dzienniki debugują informacje do konsoli.

Podpis:

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

Parametry

Zwroty:

każdy

funkcja (rodzic, ...)

Dziecko (rodzic, ścieżka)

Otrzymuje Reference do lokalizacji na określonej ścieżce względnej.

Ścieżka względna może być prostym imieniem dziecięcym (na przykład „Ada”) lub głębszą ścieżką oddzieloną odcinającą (na przykład „ADA/Nazwa/First”).

Podpis:

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

Parametry

Zwroty:

DatabaseReference

Określona lokalizacja dziecka.

push (rodzic, wartość)

Generuje nową lokalizację dziecka przy użyciu unikalnego klucza i zwraca jego Reference .

Jest to najczęstszy wzorzec dodawania danych do zbioru elementów.

Jeśli podasz wartość do push() , Wartość jest zapisywana w wygenerowanej lokalizacji. Jeśli nie przekroczysz wartości, nic nie jest zapisywane do bazy danych, a dziecko pozostaje puste (ale możesz użyć Reference w innym miejscu).

Unikalne klucze generowane przez push() są uporządkowane w bieżącym czasie, więc wynikowa lista elementów jest sortowana chronologicznie. Klucze są również zaprojektowane tak, aby były niewłaściwe (zawierają 72 losowe kawałki entropii).

Zobacz dołącz do listy danych . Zobacz 2^120 sposobów na zapewnienie unikalnych identyfikatorów .

Podpis:

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

Parametry

Zwroty:

WenBleReference

Połączona Promise i Reference ; Rozwiązuje się, gdy zapis jest kompletny, ale może być używany natychmiast jako Reference do lokalizacji dziecka.

funkcja (ścieżka, ...)

OrderbyChild (ścieżka)

Tworzy nowe QueryConstraint , które zamówi przez określony klucz dziecięcy.

Zapytania mogą zamówić tylko jeden klucz na raz. Calling orderByChild() wiele razy na tym samym zapytaniu jest błędem.

Zapytania Firebase pozwalają zamówić dane według dowolnego klucza dziecięcego w locie. Jeśli jednak wiesz z góry, jakie będą twoje indeksy, możesz je zdefiniować za pomocą reguły .Indexon w swoich zasadach bezpieczeństwa w celu lepszej wydajności. Więcej informacji można znaleźć w zasadzie https://firebase.google.com/docs/database/security/indexing-data .

Możesz przeczytać więcej o orderByChild() w danych sortowania .

Podpis:

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

Parametry

Zwroty:

QueryConstraint

funkcja (zapytanie, ...)

Get (zapytanie)

Uzyskuje najbardziej aktualny wynik tego zapytania.

Podpis:

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

Parametry

Zwroty:

Obiecaj < DataSnapshot >

Promise , która ustępuje wynikowej danych danych, jeśli wartość jest dostępna, lub odrzuca, jeśli klient nie jest w stanie zwrócić wartości (np. Jeśli serwer jest nieosiągalny i nie ma żadnego buforowania).

Off (zapytanie, eventType, callback)

Odłącza wywołanie wywoławcze uprzednio dołączone do odpowiedniego on*() ( onValue , onChildAdded ) słuchacz. Uwaga: Nie jest to zalecany sposób usunięcia słuchacza. Zamiast tego użyj zwróconej funkcji wywołania zwrotnego z odpowiedniego on* Callback.

Odłącz oddzwonienie wcześniej dołączone do on*() . Calling off() na słuchaczu nadrzędnym nie usunie automatycznie słuchaczy off() na węzłach dziecięcych, należy również wezwać słuchaczy dziecięcych, aby usunęły zwrot oddzwonienia.

Jeśli wywołanie zwrotne nie zostanie określone, wszystkie wywołania zwrotne dla określonego typu zdarzenia zostaną usunięte. Podobnie, jeśli nie zostanie określony typ zdarzenia, wszystkie wywołania zwrotne na podstawie Reference zostaną usunięte.

Poszczególnych słuchaczy można również usunąć, wywołując swoje oddzwonienia do subskrypcji.

Podpis:

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

Parametry

Zwroty:

próżnia

onChildAdded (zapytanie, oddzwonienie, anulowanie oddzwaniania)

Słucha zmian danych w określonej lokalizacji.

Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .

Wydarzenie onChildAdded zostanie uruchomione raz dla każdego początkowego dziecka w tym miejscu i zostanie ponownie uruchomione za każdym razem, gdy dodaje się nowe dziecko. DataSnapshot przekazany do wywołania zwrotnego odzwierciedla dane dla odpowiedniego dziecka. W celu zamawiania jest to drugi argument, który jest ciągiem zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null , jeśli jest to pierwsze dziecko.

Podpis:

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

Parametry

Zwroty:

Zrezygnuj z subskrypcji

Funkcja, którą można wywołać w celu usunięcia słuchacza.

onChildAdded (zapytanie, wywołanie zwrotne, opcje)

Słucha zmian danych w określonej lokalizacji.

Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .

Wydarzenie onChildAdded zostanie uruchomione raz dla każdego początkowego dziecka w tym miejscu i zostanie ponownie uruchomione za każdym razem, gdy dodaje się nowe dziecko. DataSnapshot przekazany do wywołania zwrotnego odzwierciedla dane dla odpowiedniego dziecka. W celu zamawiania jest to drugi argument, który jest ciągiem zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null , jeśli jest to pierwsze dziecko.

Podpis:

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

Parametry

Zwroty:

Zrezygnuj z subskrypcji

Funkcja, którą można wywołać w celu usunięcia słuchacza.

onchildadded (zapytanie, oddzwonienie, anulowaniecalback, opcje)

Słucha zmian danych w określonej lokalizacji.

Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .

Wydarzenie onChildAdded zostanie uruchomione raz dla każdego początkowego dziecka w tym miejscu i zostanie ponownie uruchomione za każdym razem, gdy dodaje się nowe dziecko. DataSnapshot przekazany do wywołania zwrotnego odzwierciedla dane dla odpowiedniego dziecka. W celu zamawiania jest to drugi argument, który jest ciągiem zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null , jeśli jest to pierwsze dziecko.

Podpis:

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

Parametry

Zwroty:

Zrezygnuj z subskrypcji

Funkcja, którą można wywołać w celu usunięcia słuchacza.

OnchildChanged (zapytanie, oddzwonienie, anulowaniecallback)

Słucha zmian danych w określonej lokalizacji.

Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .

Zdarzenie onChildChanged zostanie uruchomione, gdy dane przechowywane u dziecka (lub któregokolwiek z jego potomków) zmienia się. Zauważ, że zdarzenie pojedynczego child_changed może reprezentować wiele zmian w dziecku. DataSnapshot przekazany do oddzwaniania będzie zawierać nową zawartość dziecka. W celu zamawiania oddzwonienie jest również przekazywane drugi argument, który jest ciągiem zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null , jeśli jest to pierwsze dziecko.

Podpis:

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

Parametry

Zwroty:

Zrezygnuj z subskrypcji

Funkcja, którą można wywołać w celu usunięcia słuchacza.

onChildChanged (zapytanie, wywołanie zwrotne, opcje)

Słucha zmian danych w określonej lokalizacji.

Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .

Zdarzenie onChildChanged zostanie uruchomione, gdy dane przechowywane u dziecka (lub któregokolwiek z jego potomków) zmienia się. Zauważ, że zdarzenie pojedynczego child_changed może reprezentować wiele zmian w dziecku. DataSnapshot przekazany do oddzwaniania będzie zawierać nową zawartość dziecka. W celu zamawiania oddzwonienie jest również przekazywane drugi argument, który jest ciągiem zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null , jeśli jest to pierwsze dziecko.

Podpis:

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

Parametry

Zwroty:

Zrezygnuj z subskrypcji

Funkcja, którą można wywołać w celu usunięcia słuchacza.

OnchildChanged (zapytanie, oddzwonienie, anulowaniecalback, opcje)

Słucha zmian danych w określonej lokalizacji.

Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .

Zdarzenie onChildChanged zostanie uruchomione, gdy dane przechowywane u dziecka (lub któregokolwiek z jego potomków) zmienia się. Zauważ, że zdarzenie pojedynczego child_changed może reprezentować wiele zmian w dziecku. DataSnapshot przekazany do oddzwaniania będzie zawierać nową zawartość dziecka. W celu zamawiania oddzwonienie jest również przekazywane drugi argument, który jest ciągiem zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null , jeśli jest to pierwsze dziecko.

Podpis:

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

Parametry

Zwroty:

Zrezygnuj z subskrypcji

Funkcja, którą można wywołać w celu usunięcia słuchacza.

onChildMoved (zapytanie, oddzwonienie, anulowanie oddzwaniania)

Słucha zmian danych w określonej lokalizacji.

Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .

Zdarzenie onChildMoved zostanie uruchomione, gdy zmienia się kolejność sortowania dziecka w taki sposób, że jego pozycja w stosunku do rodzeństwa się zmienia. DataSnapshot przekazany do wywołania zwrotnym będzie dotyczyło danych, które poruszyło się dziecko. Jest to również drugi argument, który jest ciągiem zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null , jeśli jest to pierwsze dziecko.

Podpis:

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

Parametry

Zwroty:

Zrezygnuj z subskrypcji

Funkcja, którą można wywołać w celu usunięcia słuchacza.

onChildMoved (zapytanie, wywołanie zwrotne, opcje)

Słucha zmian danych w określonej lokalizacji.

Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .

Zdarzenie onChildMoved zostanie uruchomione, gdy zmienia się kolejność sortowania dziecka w taki sposób, że jego pozycja w stosunku do rodzeństwa się zmienia. DataSnapshot przekazany do wywołania zwrotnym będzie dotyczyło danych, które poruszyło się dziecko. Jest to również drugi argument, który jest ciągiem zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null , jeśli jest to pierwsze dziecko.

Podpis:

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

Parametry

Zwroty:

Zrezygnuj z subskrypcji

Funkcja, którą można wywołać w celu usunięcia słuchacza.

onchildmoved (zapytanie, oddzwonienie, anulowaniecalback, opcje)

Słucha zmian danych w określonej lokalizacji.

Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .

Zdarzenie onChildMoved zostanie uruchomione, gdy zmienia się kolejność sortowania dziecka w taki sposób, że jego pozycja w stosunku do rodzeństwa się zmienia. DataSnapshot przekazany do wywołania zwrotnym będzie dotyczyło danych, które poruszyło się dziecko. Jest to również drugi argument, który jest ciągiem zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null , jeśli jest to pierwsze dziecko.

Podpis:

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

Parametry

Zwroty:

Zrezygnuj z subskrypcji

Funkcja, którą można wywołać w celu usunięcia słuchacza.

onchildRemoved (zapytanie, oddzwonienie, anulowaniecallback)

Słucha zmian danych w określonej lokalizacji.

Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .

Wydarzenie onChildRemoved zostanie uruchomione raz za każdym razem, gdy dziecko zostanie usunięte. DataSnapshot przekazany do oddzwaniania będzie starymi danymi dla usuniętego dziecka. Dziecko zostanie usunięte, gdy:

• Klient wyraźnie dzwoni do remove() na to dziecko lub jednego z jego przodków - klient wywołuje set(null) na to dziecko lub jeden z jego przodków - to dziecko ma usunięte wszystkie swoje dzieci - obowiązuje zapytanie, które teraz filtruje filtry Out dziecko (ponieważ jest to kolejność sortowania lub maksymalny limit został trafiony)

Podpis:

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

Parametry

Zwroty:

Zrezygnuj z subskrypcji

Funkcja, którą można wywołać w celu usunięcia słuchacza.

onchildRemoved (zapytanie, oddzwonienie, opcje)

Słucha zmian danych w określonej lokalizacji.

Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .

Wydarzenie onChildRemoved zostanie uruchomione raz za każdym razem, gdy dziecko zostanie usunięte. DataSnapshot przekazany do oddzwaniania będzie starymi danymi dla usuniętego dziecka. Dziecko zostanie usunięte, gdy:

• Klient wyraźnie dzwoni do remove() na to dziecko lub jednego z jego przodków - klient wywołuje set(null) na to dziecko lub jeden z jego przodków - to dziecko ma usunięte wszystkie swoje dzieci - obowiązuje zapytanie, które teraz filtruje filtry Out dziecko (ponieważ jest to kolejność sortowania lub maksymalny limit został trafiony)

Podpis:

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

Parametry

Zwroty:

Zrezygnuj z subskrypcji

Funkcja, którą można wywołać w celu usunięcia słuchacza.

onchildRemoved (zapytanie, oddzwonienie, anulowaniecalback, opcje)

Słucha zmian danych w określonej lokalizacji.

Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .

Wydarzenie onChildRemoved zostanie uruchomione raz za każdym razem, gdy dziecko zostanie usunięte. DataSnapshot przekazany do oddzwaniania będzie starymi danymi dla usuniętego dziecka. Dziecko zostanie usunięte, gdy:

• Klient wyraźnie dzwoni do remove() na to dziecko lub jednego z jego przodków - klient wywołuje set(null) na to dziecko lub jeden z jego przodków - to dziecko ma usunięte wszystkie swoje dzieci - obowiązuje zapytanie, które teraz filtruje filtry Out dziecko (ponieważ jest to kolejność sortowania lub maksymalny limit został trafiony)

Podpis:

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

Parametry

Zwroty:

Zrezygnuj z subskrypcji

Funkcja, którą można wywołać w celu usunięcia słuchacza.

OnValue (zapytanie, oddzwonienie, anulowaniecalback)

Słucha zmian danych w określonej lokalizacji.

Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .

Zdarzenie onValue uruchomi się raz z początkowymi danymi przechowywanymi w tej lokalizacji, a następnie wywoła ponownie za każdym razem, gdy dane dane. DataSnapshot przekazany do oddzwaniania będzie miało miejsce dla lokalizacji, w której wezwano on() . Nie uruchomi się, dopóki cała zawartość nie zostanie zsynchronizowana. Jeśli lokalizacja nie ma danych, zostanie uruchomiona pustym DataSnapshot ( val() zwróci null ).

Podpis:

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

Parametry

Zwroty:

Zrezygnuj z subskrypcji

Funkcja, którą można wywołać w celu usunięcia słuchacza.

OnValue (zapytanie, oddzwonienie, opcje)

Słucha zmian danych w określonej lokalizacji.

Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .

Zdarzenie onValue uruchomi się raz z początkowymi danymi przechowywanymi w tej lokalizacji, a następnie wywoła ponownie za każdym razem, gdy dane dane. DataSnapshot przekazany do oddzwaniania będzie miało miejsce dla lokalizacji, w której wezwano on() . Nie uruchomi się, dopóki cała zawartość nie zostanie zsynchronizowana. Jeśli lokalizacja nie ma danych, zostanie uruchomiona pustym DataSnapshot ( val() zwróci null ).

Podpis:

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

Parametry

Zwroty:

Zrezygnuj z subskrypcji

Funkcja, którą można wywołać w celu usunięcia słuchacza.

onValue (zapytanie, oddzwonienie, odwołanie, opcje)

Słucha zmian danych w określonej lokalizacji.

Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .

Zdarzenie onValue uruchomi się raz z początkowymi danymi przechowywanymi w tej lokalizacji, a następnie wywoła ponownie za każdym razem, gdy dane dane. DataSnapshot przekazany do oddzwaniania będzie miało miejsce dla lokalizacji, w której wezwano on() . Nie uruchomi się, dopóki cała zawartość nie zostanie zsynchronizowana. Jeśli lokalizacja nie ma danych, zostanie uruchomiona pustym DataSnapshot ( val() zwróci null ).

Podpis:

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

Parametry

Zwroty:

Zrezygnuj z subskrypcji

Funkcja, którą można wywołać w celu usunięcia słuchacza.

Zapytanie (zapytanie, QueryConstraints)

Tworzy nowy niezmienny przykład Query , który jest rozszerzony o dodatkowe ograniczenia zapytania.

Podpis:

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

Parametry

Zwroty:

Zapytanie

Wyjątki

Jeżeli którekolwiek z dostarczonych ograniczeń zapytania nie można połączyć z istniejącymi lub nowymi ograniczeniami.

funkcja (ref, ...)

ondisconnect (ref)

Zwraca obiekt OnDisconnect - patrz Włączanie możliwości offline w JavaScript, aby uzyskać więcej informacji o tym, jak go używać.

Podpis:

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

Parametry

Zwroty:

Ondisconnect

Usuń (Ref)

Usuwa dane w tej lokalizacji bazy danych.

Wszelkie dane w lokalizacjach dzieci również zostaną usunięte.

Efekt usunięcia będzie natychmiast widoczny, a odpowiednia „wartość” zdarzenia zostanie uruchomiona. Synchronization of the remove 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.

Podpis:

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

Parametry

Zwroty:

Promise<void>

Resolves when remove on server is complete.

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.

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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

Parametry

Zwroty:

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

Podpis:

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

Parametry

Zwroty:

Promise<void>

Resolves when write to server is complete.

setWithPriority(ref, wartość, priorytet)

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

Podpis:

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

Parametry

Zwroty:

Promise<void>

Resolves when write to server is complete.

update(ref, values)

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 .

Podpis:

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

Parametry

Zwroty:

Promise<void>

Resolves when update on server is complete.

function(value, ...)

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 .

Podpis:

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

Parametry

Zwroty:

QueryConstraint

endBefore(value, key)

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.

Podpis:

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

Parametry

Zwroty:

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 .

Podpis:

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

Parametry

Zwroty:

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.

Podpis:

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

Parametry

Zwroty:

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 .

Podpis:

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

Parametry

Zwroty:

QueryConstraint

Typ wydarzenia

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

Podpis:

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

QueryConstraintType

Describes the different query constraints available in this SDK.

Podpis:

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

Zrezygnuj z subskrypcji

A callback that can invoked to remove a listener.

Podpis:

export declare type Unsubscribe = () => void;