app package

Aplikacja Firebase

Ten pakiet koordynuje komunikację między różnymi komponentami Firebase

Funkcje

Funkcja Opis
function(aplikacja, ...)
deleteApp(aplikacja) Sprawia, że aplikacja jest bezużyteczna, i zwalnia zasoby wszystkich powiązanych usług.
function()
getApps() Tablica (tylko do odczytu) ze wszystkimi zainicjowanymi aplikacjami.
initializeApp() Tworzy i inicjuje instancję FirebaseApp.
function(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, wersja, wariant) Rejestruje nazwę i wersję biblioteki na potrzeby logowania się na platformie.
function(logCallback, ...)
onLog(logCallback, options) Ustawia moduł obsługi logów dla wszystkich pakietów SDK Firebase.
function(logLevel, ...)
setLogLevel(logLevel) Ustawia poziom rejestrowania dla wszystkich pakietów SDK Firebase.Rejestrowane są wszystkie typy logów powyżej bieżącego poziomu (tzn. jeśli ustawisz poziom logowania na info, błędy będą rejestrowane, ale logi debug i verbose nie).
funkcja(nazwa, ...)
getApp(nazwa) Pobiera instancję FirebaseApp.Jeśli wywołasz ją bez argumentów, zwracana jest aplikacja domyślna. Po podaniu nazwy aplikacji zwracana jest aplikacja odpowiadająca tej nazwie.Jeśli pobrana aplikacja nie została jeszcze zainicjowana, zgłaszany jest wyjątek.
function(opcje, ...)
initializeApp(opcje, nazwa) Tworzy i inicjuje instancję FirebaseApp.Szczegółowe informacje znajdziesz w artykułach Dodawanie Firebase do aplikacji i Inicjowanie wielu projektów.
initializeApp(opcje, konfiguracja) Tworzy i inicjuje instancję FirebaseApp.
initializeServerApp(opcje, konfiguracja) Tworzy i inicjuje instancję FirebaseServerApp.FirebaseServerApp jest podobny do FirebaseApp, ale jest przeznaczony do wykonywania tylko w środowiskach renderowania po stronie serwera. Inicjowanie nie powiedzie się w przypadku wywołania ze środowiska przeglądarki.Szczegółową dokumentację znajdziesz w artykułach Dodawanie Firebase do aplikacji i Inicjowanie wielu projektów.

Interfejsy

Interfejs Opis
Aplikacja Firebase FirebaseApp przechowuje informacje o inicjowaniu kolekcji usług.Nie wywołaj tego konstruktora bezpośrednio. Zamiast tego do utworzenia aplikacji użyj funkcji initializeApp().
Ustawienia aplikacji Firebase Opcje konfiguracji dostępne dla initializeApp()
FirebaseOptions. Obiekt konfiguracji Firebase. Zawiera zestaw parametrów wymaganych przez usługi do skutecznej komunikacji z interfejsami API serwera Firebase i powiązania danych klienta z projektem Firebase i aplikacją Firebase. Zwykle ten obiekt wypełnia konsola Firebase podczas konfiguracji projektu. Zobacz też: Więcej informacji o obiekcie konfiguracyjnym Firebase.
Aplikacja serwera Firebase FirebaseServerApp zawiera informacje o inicjowaniu zbioru usług działających w środowiskach serwera.Nie wywołaj tego konstruktora bezpośrednio. Zamiast tego do utworzenia aplikacji użyj initializeServerApp().
Ustawienia aplikacji serwera Firebase Opcje konfiguracji podane dla initializeServerApp()

Zmienne

Zmienna Opis
SDK_VERSION Aktualna wersja pakietu SDK.

funkcja(aplikacja, ...)

deleteApp(aplikacja)

Sprawia, że aplikacja jest bezużyteczna, i zwalnia zasoby wszystkich powiązanych usług.

Podpis:

export declare function deleteApp(app: FirebaseApp): Promise<void>;

Parametry

Parametr Typ Opis
aplikacja Aplikacja Firebase

Zwroty:

Obietnica<void>

Przykład

deleteApp(app)
  .then(function() {
    console.log("App deleted successfully");
  })
  .catch(function(error) {
    console.log("Error deleting app:", error);
  });

funkcja()

getApps()

Tablica (tylko do odczytu) ze wszystkimi zainicjowanymi aplikacjami.

Podpis:

export declare function getApps(): FirebaseApp[];

Zwroty:

Aplikacja Firebase[]

inicjujApp()

Tworzy i inicjuje instancję FirebaseApp.

Podpis:

export declare function initializeApp(): FirebaseApp;

Zwroty:

Aplikacja Firebase

function(libraryKeyOrName, ...)

rejestracja wersja(nazwa_klucza_biblioteki; wersja; wariant)

Rejestruje nazwę i wersję biblioteki na potrzeby logowania się na platformie.

Podpis:

export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;

Parametry

Parametr Typ Opis
Nazwa_bibliotekiklucza_lub_nazwa_biblioteki ciąg znaków
wersja ciąg znaków Bieżąca wersja tej biblioteki.
variant ciąg znaków Wariant pakietu, np. węzeł, rn itd.

Zwroty:

nieważne

function(logCallback, ...)

onLog(logCallback; opcje)

Ustawia moduł obsługi logów dla wszystkich pakietów SDK Firebase.

Podpis:

export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;

Parametry

Parametr Typ Opis
rejestr wywołań zwrotnych LogCallback | wartość null Opcjonalny niestandardowy moduł obsługi logów, który wykonuje kod użytkownika za każdym razem, gdy pakiet SDK Firebase wywołuje logowanie.
opcje Opcje logu

Zwroty:

nieważne

function(logLevel, ...)

setLogLevel(logLevel)

Ustawia poziom rejestrowania dla wszystkich pakietów SDK Firebase.

Przechwytywane są wszystkie typy logów powyżej bieżącego poziomu (tzn. jeśli ustawisz poziom logowania na info, błędy będą rejestrowane, ale logi debug i verbose nie).

Podpis:

export declare function setLogLevel(logLevel: LogLevelString): void;

Parametry

Parametr Typ Opis
poziom logu Ciąg logu

Zwroty:

nieważne

funkcja(nazwa, ...)

getApp(nazwa)

Pobiera instancję FirebaseApp.

W przypadku wywołania bez argumentów zwracana jest aplikacja domyślna. Jeśli podasz nazwę aplikacji, zwrócona zostanie aplikacja odpowiadająca tej nazwie.

Jeśli pobierana aplikacja nie została jeszcze zainicjowana, zgłaszany jest wyjątek.

Podpis:

export declare function getApp(name?: string): FirebaseApp;

Parametry

Parametr Typ Opis
nazwa ciąg znaków Opcjonalna nazwa aplikacji do zwrócenia. Jeśli nie podasz nazwy, domyślna wartość to "[DEFAULT]".

Zwroty:

Aplikacja Firebase

Aplikacja odpowiadająca podanej nazwie aplikacji. Jeśli nie podasz nazwy aplikacji, zostanie zwrócona domyślna aplikacja.

Przykład 1

// Return the default app
const app = getApp();

Przykład 2

// Return a named app
const otherApp = getApp("otherApp");

funkcja(opcje, ...)

inicjujApp(opcje, nazwa)

Tworzy i inicjuje instancję FirebaseApp.

Szczegółową dokumentację znajdziesz w artykułach Dodawanie Firebase do aplikacji i Inicjowanie wielu projektów.

Podpis:

export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;

Parametry

Parametr Typ Opis
opcje FirebaseOptions. Opcje konfigurowania usług aplikacji.
nazwa ciąg znaków Opcjonalna nazwa aplikacji do zainicjowania. Jeśli nie podasz nazwy, domyślna wartość to "[DEFAULT]".

Zwroty:

Aplikacja Firebase

Zainicjowana aplikacja.

Przykład 1


// Initialize default app
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeApp({
  apiKey: "AIza....",                             // Auth / General Use
  authDomain: "YOUR_APP.firebaseapp.com",         // Auth with popup/redirect
  databaseURL: "https://YOUR_APP.firebaseio.com", // Realtime Database
  storageBucket: "YOUR_APP.appspot.com",          // Storage
  messagingSenderId: "123456789"                  // Cloud Messaging
});

Przykład 2


// Initialize another app
const otherApp = initializeApp({
  databaseURL: "https://<OTHER_DATABASE_NAME>.firebaseio.com",
  storageBucket: "<OTHER_STORAGE_BUCKET>.appspot.com"
}, "otherApp");

inicjacjaApp(opcje, konfiguracja)

Tworzy i inicjuje instancję FirebaseApp.

Podpis:

export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;

Parametry

Parametr Typ Opis
opcje FirebaseOptions. Opcje konfigurowania usług aplikacji.
konfiguracja Ustawienia aplikacji Firebase Konfiguracja aplikacji Firebase

Zwroty:

Aplikacja Firebase

zainicjujServerApp(opcje, konfiguracja)

Tworzy i inicjuje instancję FirebaseServerApp.

Pole FirebaseServerApp jest podobne do FirebaseApp, ale jest przeznaczone do wykonywania tylko w środowiskach renderowania po stronie serwera. Inicjalizacja się nie uda, jeśli zostanie wywołana ze środowiska przeglądarki.

Szczegółową dokumentację znajdziesz w artykułach Dodawanie Firebase do aplikacji i Inicjowanie wielu projektów.

Podpis:

export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;

Parametry

Parametr Typ Opis
opcje FirebaseOptions | Aplikacja Firebase Firebase.AppOptions, aby skonfigurować usługi aplikacji, lub wystąpienie FirebaseApp zawierające AppOptions.
konfiguracja Ustawienia aplikacji serwera Firebase Konfiguracja: FirebaseServerApp.

Zwroty:

Aplikacja serwera Firebase

Zainicjowano FirebaseServerApp.

Przykład


// Initialize an instance of `FirebaseServerApp`.
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeServerApp({
    apiKey: "AIza....",                             // Auth / General Use
    authDomain: "YOUR_APP.firebaseapp.com",         // Auth with popup/redirect
    databaseURL: "https://YOUR_APP.firebaseio.com", // Realtime Database
    storageBucket: "YOUR_APP.appspot.com",          // Storage
    messagingSenderId: "123456789"                  // Cloud Messaging
  },
  {
   authIdToken: "Your Auth ID Token"
  });

SDK_VERSION

Aktualna wersja pakietu SDK.

Podpis:

SDK_VERSION: string