app package

Firebase App

Dieses Paket koordiniert die Kommunikation zwischen den verschiedenen Firebase-Komponenten

Funktionen

Funktion Beschreibung
function(App, ...)
deleteApp(App) Macht diese App unbrauchbar und gibt die Ressourcen von allen verknüpften Diensten frei.
Funktion()
getApps() Ein (schreibgeschütztes) Array aller initialisierten Apps.
initializeApp() Erstellt und initialisiert eine FirebaseApp-Instanz.
function(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, version, variant) Registriert den Namen und die Version einer Bibliothek für Plattform-Logging.
function(logCallback, ...)
onLog(logCallback, options) Legt den Log-Handler für alle Firebase SDKs fest.
function(logLevel, ...)
setLogLevel(logLevel) Legt die Logebene für alle Firebase SDKs fest.Alle Logtypen oberhalb der aktuellen Logebene werden erfasst (d.h., wenn du die Logebene auf info festlegst, werden Fehler protokolliert, die Logs vom Typ debug und verbose jedoch nicht).
function(Name, ...)
getApp(Name) Ruft eine FirebaseApp ab.Beim Aufruf ohne Argumente wird die Standard-App zurückgegeben. Wenn ein App-Name angegeben wird, wird die App zurückgegeben, die diesem Namen entspricht.Wenn die abgerufene App noch nicht initialisiert wurde, wird eine Ausnahme ausgelöst.
function(Optionen, ...)
initialApp(options, name) Erstellt und initialisiert eine FirebaseApp.Eine ausführliche Dokumentation finden Sie unter Firebase zu Ihrer App hinzufügen und Mehrere Projekte initialisieren.
initialApp(options, config) Erstellt und initialisiert eine FirebaseApp-Instanz.
initialServerApp(options, config) Erstellt und initialisiert eine FirebaseServerApp-Instanz.Die FirebaseServerApp ähnelt FirebaseApp, ist aber nur für die Ausführung in serverseitigen Rendering-Umgebungen vorgesehen. Die Initialisierung schlägt fehl, wenn sie über eine Browserumgebung aufgerufen wird.Eine ausführliche Dokumentation finden Sie unter Firebase zu Ihrer App hinzufügen und Mehrere Projekte initialisieren.

Interfaces

Schnittstelle Beschreibung
FirebaseApp Eine FirebaseApp enthält die Initialisierungsinformationen für eine Sammlung von Diensten.Rufen Sie diesen Konstruktor nicht direkt auf. Verwenden Sie stattdessen initializeApp(), um eine App zu erstellen.
FirebaseAppSettings Konfigurationsoptionen für initializeApp()
FirebaseOptions Firebase-Konfigurationsobjekt Enthält eine Reihe von Parametern, die von Diensten benötigt werden, um mit Firebase Server APIs zu kommunizieren und Kundendaten mit Ihrem Firebase-Projekt und Ihrer Firebase-Anwendung zu verknüpfen. Dieses Objekt wird normalerweise bei der Projekteinrichtung über die Firebase Console ausgefüllt. Weitere Informationen finden Sie unter Informationen zum Firebase-Konfigurationsobjekt.
FirebaseServerApp Eine FirebaseServerApp enthält die Initialisierungsinformationen für eine Sammlung von Diensten, die in Serverumgebungen ausgeführt werden.Rufen Sie diesen Konstruktor nicht direkt auf. Verwenden Sie stattdessen initialServerApp(), um eine App zu erstellen.
FirebaseServerAppSettings Konfigurationsoptionen für initialServerApp()

Variablen

Variable Beschreibung
SDK_VERSION Die aktuelle SDK-Version.

Funktion(App; ...)

DeleteApp(App)

Macht diese App unbrauchbar und gibt die Ressourcen von allen verknüpften Diensten frei.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
App FirebaseApp

Gibt zurück:

Promise<void>

Beispiel

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

Funktion()

getApps()

Ein (schreibgeschütztes) Array aller initialisierten Apps.

Unterschrift:

export declare function getApps(): FirebaseApp[];

Gibt zurück:

FirebaseApp[]

initializeApp()

Erstellt und initialisiert eine FirebaseApp-Instanz.

Unterschrift:

export declare function initializeApp(): FirebaseApp;

Gibt zurück:

FirebaseApp

Funktion(libraryKeyOrName, ...)

registerVersion(libraryKeyOrName, version, variant)

Registriert den Namen und die Version einer Bibliothek für Plattform-Logging.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
libraryKeyOrName String
Version String Die aktuelle Version dieser Bibliothek.
variant String Bundle-Variante, z.B. Knoten, rn usw.

Gibt zurück:

void

Funktion(logCallback, ...)

onLog(logCallback, Optionen)

Legt den Log-Handler für alle Firebase SDKs fest.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
logCallback LogCallback | null Ein optionaler benutzerdefinierter Log-Handler, der jedes Mal Nutzercode ausführt, wenn das Firebase SDK einen Logging-Aufruf durchführt.
Optionen LogOptions

Gibt zurück:

void

Funktion(logLevel; ...)

setLogLevel(logLevel)

Legt die Logebene für alle Firebase SDKs fest.

Alle Logtypen oberhalb der aktuellen Logebene werden erfasst (d.h., wenn Sie die Logebene auf info festlegen, werden Fehler protokolliert, debug- und verbose-Logs nicht).

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
logLevel LogLevelString

Gibt zurück:

void

Funktion(Name; ...)

getApp(Name)

Ruft eine FirebaseApp-Instanz ab.

Beim Aufruf ohne Argumente wird die Standardanwendung zurückgegeben. Wenn ein App-Name angegeben wird, wird die entsprechende App zurückgegeben.

Es wird eine Ausnahme ausgelöst, wenn die abzurufende App noch nicht initialisiert wurde.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
name String Optionaler Name der Anwendung, die zurückgegeben werden soll. Wenn kein Name angegeben wird, wird der Standardwert "[DEFAULT]" verwendet.

Gibt zurück:

FirebaseApp

Die App, die dem angegebenen App-Namen entspricht Wenn kein App-Name angegeben ist, wird die Standard-App zurückgegeben.

Beispiel 1

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

Beispiel 2

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

Funktion(Optionen; ...)

initialApp(Optionen, Name)

Erstellt und initialisiert eine FirebaseApp-Instanz.

Eine ausführliche Dokumentation finden Sie unter Firebase zu Ihrer App hinzufügen und Mehrere Projekte initialisieren.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Optionen FirebaseOptions Optionen zum Konfigurieren der Dienste der Anwendung.
name String Optionaler Name der zu initialisierenden App. Wenn kein Name angegeben wird, wird der Standardwert "[DEFAULT]" verwendet.

Gibt zurück:

FirebaseApp

Die initialisierte App.

Beispiel 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
});

Beispiel 2


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

initialApp(Optionen, Konfiguration)

Erstellt und initialisiert eine FirebaseApp-Instanz.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Optionen FirebaseOptions Optionen zum Konfigurieren der Dienste der Anwendung.
config FirebaseAppSettings FirebaseApp-Konfiguration

Gibt zurück:

FirebaseApp

initialServerApp(Optionen, Konfiguration)

Erstellt und initialisiert eine FirebaseServerApp-Instanz.

FirebaseServerApp ähnelt FirebaseApp, ist aber nur für die Ausführung in serverseitigen Rendering-Umgebungen vorgesehen. Die Initialisierung schlägt fehl, wenn sie über eine Browserumgebung aufgerufen wird.

Eine ausführliche Dokumentation finden Sie unter Firebase zu Ihrer App hinzufügen und Mehrere Projekte initialisieren.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Optionen FirebaseOptions | FirebaseApp Firebase.AppOptions, um die Dienste der Anwendung zu konfigurieren, oder eine FirebaseApp-Instanz, die AppOptions enthält.
config FirebaseServerAppSettings FirebaseServerApp-Konfiguration.

Gibt zurück:

FirebaseServerApp

Die initialisierte FirebaseServerApp.

Beispiel


// 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

Die aktuelle SDK-Version.

Unterschrift:

SDK_VERSION: string