app package

Aplikacja Firebase

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

Funkcje

Funkcja Opis
funkcja(aplikacja, ...)
deleteApp(app) Aplikacja sprawia, że jest bezużyteczna, i bezpłatne zasoby wszystkich powiązanych usług.
function()
getApps() Tablica (tylko do odczytu) wszystkich zainicjowanych aplikacji.
initializeApp() Tworzy i inicjuje instancję aplikacji Firebase.
funkcja(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, version, variant) Rejestruje nazwę i wersję biblioteki na potrzeby logowania platformy.
funkcja(logCallback, ...)
onLog(logCallback, opcje) Konfiguruje moduł obsługi logów dla wszystkich pakietów SDK Firebase.
function(logLevel, ...)
setLogLevel(logLevel) Ustawia poziom logowania dla wszystkich pakietów SDK Firebase.Przechwytywane są wszystkie typy logów powyżej bieżącego poziomu logu (np. 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.Po wywołaniu bez argumentów zwracana jest aplikacja domyślna. Po podaniu nazwy aplikacji zwracana jest aplikacja, która mu odpowiada.Jeśli pobierana aplikacja nie została jeszcze zainicjowana, wyjątek jest zgłaszany.
funkcja(opcje, ...)
initializeApp(opcje; nazwa) Tworzy i inicjuje instancję FirebaseApp.Szczegółową dokumentację znajdziesz w artykułach Dodawanie Firebase do aplikacji i Inicjowanie wielu projektów.
initializeApp(opcje, konfiguracja) Tworzy i inicjuje instancję aplikacji Firebase.
initializeServerApp(opcje, konfiguracja) Tworzy i inicjuje instancję FirebaseServerApp.FirebaseServerApp jest podobny do FirebaseApp, ale jest przeznaczony do wykonywania wyłącznie w środowiskach renderowania po stronie serwera. Inicjacja nie powiedzie się, 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.

Interfejsy

Interfejs Opis
FirebaseApp FirebaseApp zawiera informacje o inicjowaniu zbioru usług.Nie wywołuj tego konstruktora bezpośrednio. Zamiast tego do utworzenia aplikacji użyj funkcji initializeApp().
FirebaseAppSettings Opcje konfiguracji podane dla funkcji initializeApp()
FirebaseOptions Obiekt konfiguracji Firebase. Zawiera zestaw parametrów wymaganych przez usługi do komunikacji z interfejsami API serwera Firebase oraz do powiązania danych klienta z projektem Firebase i aplikacją Firebase. Zwykle ten obiekt jest wypełniany przez konsolę Firebase podczas konfiguracji projektu. Zobacz też: Informacje o obiekcie konfiguracyjnym Firebase.
FirebaseServerApp Parametr FirebaseServerApp zawiera informacje o inicjowaniu zbioru usług działających w środowiskach serwera.Nie wywołuj tego konstruktora bezpośrednio. Zamiast tego do utworzenia aplikacji użyj metody initializeServerApp().
FirebaseServerAppSettings Opcje konfiguracji dla funkcji initializeServerApp()

Zmienne

Zmienna Opis
SDK_VERSION Aktualna wersja pakietu SDK.

funkcja(aplikacja, ...)

deleteApp(aplikacja)

Aplikacja sprawia, że jest bezużyteczna, i bezpłatne zasoby wszystkich powiązanych usług.

Podpis:

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

Parametry

Parametr Typ Opis
aplikacja FirebaseApp

Zwroty:

Promise<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) wszystkich zainicjowanych aplikacji.

Podpis:

export declare function getApps(): FirebaseApp[];

Zwroty:

FirebaseApp[]

initializeApp()

Tworzy i inicjuje instancję aplikacji Firebase.

Podpis:

export declare function initializeApp(): FirebaseApp;

Zwroty:

FirebaseApp

funkcja(libraryKeyOrName, ...)

registerVersion(libraryKeyOrName, version, variant)

Rejestruje nazwę i wersję biblioteki na potrzeby logowania platformy.

Podpis:

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

Parametry

Parametr Typ Opis
libraryKeyOrName string,
wersja string, Aktualna wersja tej biblioteki.
variant string, Wariant pakietu, np. węzeł, rn itp.

Zwroty:

void

funkcja(logCallback, ...)

onLog(logCallback, opcje)

Konfiguruje 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
logCallback LogCallback | null Opcjonalny niestandardowy moduł obsługi dzienników, który wykonuje kod użytkownika za każdym razem, gdy pakiet SDK Firebase wykonuje wywołanie logowania.
Opcje LogOptions

Zwroty:

void

funkcja(logLevel, ...)

setLogLevel(logLevel)

Ustawia poziom logowania dla wszystkich pakietów SDK Firebase.

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

Podpis:

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

Parametry

Parametr Typ Opis
logLevel LogLevelString

Zwroty:

void

funkcja(nazwa, ...)

getApp(nazwa)

Pobiera instancję FirebaseApp.

W przypadku wywołania bez argumentów zwracana jest domyślna aplikacja. Po podaniu nazwy aplikacji zwracana jest aplikacja, która jej odpowiada.

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 string, Opcjonalna nazwa aplikacji do zwrócenia. Jeśli nie podasz nazwy, domyślną wartością jest "[DEFAULT]".

Zwroty:

FirebaseApp

Aplikacja odpowiadająca podanej nazwie aplikacji. Jeśli nie podasz nazwy aplikacji, zwracana jest aplikacja domyślna.

Przykład 1

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

Przykład 2

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

funkcja(opcje, ...)

zainicjujApp(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 string, Opcjonalna nazwa aplikacji do zainicjowania. Jeśli nie podasz nazwy, domyślną wartością jest "[DEFAULT]".

Zwroty:

FirebaseApp

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");

zainicjujApp(opcje, konfiguracja)

Tworzy i inicjuje instancję aplikacji Firebase.

Podpis:

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

Parametry

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

Zwroty:

FirebaseApp

zainicjujServerApp(opcje, konfiguracja)

Tworzy i inicjuje instancję FirebaseServerApp.

Polecenie FirebaseServerApp jest podobne do zasady FirebaseApp, ale jest przeznaczone do wykonywania tylko w środowiskach renderowania po stronie serwera. Inicjacja nie powiedzie się, 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 | FirebaseApp Firebase.AppOptions, aby skonfigurować usługi aplikacji, lub instancję FirebaseApp, która zawiera interfejs AppOptions.
konfiguracja FirebaseServerAppSettings Konfiguracja funkcji FirebaseServerApp.

Zwroty:

FirebaseServerApp

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