app package

Application Firebase

Ce package coordonne la communication entre les différents composants Firebase

Les fonctions

Fonction Description
fonction(application, ...)
supprimer l'application (application) Rend cette application inutilisable et libère les ressources de tous les services associés.
fonction()
getApps() Un tableau (en lecture seule) de toutes les applications initialisées.
initialiserApp() Crée et initialise une instance FirebaseApp.
fonction (libraryKeyOrName, ...)
registerVersion (libraryKeyOrName, version, variante) Enregistre le nom et la version d'une bibliothèque à des fins de journalisation de la plateforme.
fonction(logCallback, ...)
onLog (logCallback, options) Définit le gestionnaire de journaux pour tous les SDK Firebase.
fonction(logLevel, ...)
setLogLevel(logNiveau) Définit le niveau de journalisation pour tous les SDK Firebase. Tous les types de journaux au-dessus du niveau de journalisation actuel sont capturés (c'est-à-dire que si vous définissez le niveau de journalisation sur info , les erreurs sont enregistrées, mais pas les journaux debug et verbose ).
fonction(nom, ...)
getApp(nom) Récupère une instance FirebaseApp . Lorsqu'elle est appelée sans argument, l'application par défaut est renvoyée. Lorsqu'un nom d'application est fourni, l'application correspondant à ce nom est renvoyée. Une exception est levée si l'application récupérée n'a pas encore été initialisée.
fonction(options, ...)
initializeApp (options, nom) Crée et initialise une instance FirebaseApp . Consultez Ajouter Firebase à votre application et Initialiser plusieurs projets pour une documentation détaillée.
initializeApp (options, configuration) Crée et initialise une instance FirebaseApp.

Interfaces

Interface Description
FirebaseApp Une FirebaseApp contient les informations d'initialisation d'un ensemble de services. N'appelez pas ce constructeur directement. Utilisez plutôt initializeApp() pour créer une application.
Paramètres de l'application Firebase Options de configuration données à initializeApp()
Options Firebase Objet de configuration Firebase. Contient un ensemble de paramètres requis par les services afin de communiquer avec succès avec les API du serveur Firebase et d'associer les données client à votre projet Firebase et à votre application Firebase. Généralement, cet objet est renseigné par la console Firebase lors de la configuration du projet. Voir aussi : En savoir plus sur l'objet de configuration Firebase .

Variables

Variable Description
SDK_VERSION La version actuelle du SDK.

fonction(application, ...)

supprimer l'application (application)

Rend cette application inutilisable et libère les ressources de tous les services associés.

Signature:

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

Paramètres

Paramètre Taper Description
application FirebaseApp

Retour:

Promesse<vide>

Exemple

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

fonction()

getApps()

Un tableau (en lecture seule) de toutes les applications initialisées.

Signature:

export declare function getApps(): FirebaseApp[];

Retour:

FirebaseApp []

initialiserApp()

Crée et initialise une instance FirebaseApp.

Signature:

export declare function initializeApp(): FirebaseApp;

Retour:

FirebaseApp

fonction (libraryKeyOrName, ...)

registerVersion (libraryKeyOrName, version, variante)

Enregistre le nom et la version d'une bibliothèque à des fins de journalisation de la plateforme.

Signature:

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

Paramètres

Paramètre Taper Description
bibliothèqueCléOuNom chaîne
version chaîne Version actuelle de cette bibliothèque.
une variante chaîne Variante de bundle, par exemple, nœud, rn, etc.

Retour:

vide

fonction(logCallback, ...)

onLog (logCallback, options)

Définit le gestionnaire de journaux pour tous les SDK Firebase.

Signature:

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

Paramètres

Paramètre Taper Description
logCallback Journal de rappel | nul Un gestionnaire de journaux personnalisé facultatif qui exécute le code utilisateur chaque fois que le SDK Firebase effectue un appel de journalisation.
choix Options de journal

Retour:

vide

fonction(logLevel, ...)

setLogLevel(logNiveau)

Définit le niveau de journalisation pour tous les SDK Firebase.

Tous les types de journaux au-dessus du niveau de journalisation actuel sont capturés (c'est-à-dire si vous définissez le niveau de journalisation sur info , les erreurs sont enregistrées, mais les journaux debug et verbose ne le sont pas).

Signature:

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

Paramètres

Paramètre Taper Description
niveau de journal Chaîne de niveau de journal

Retour:

vide

fonction(nom, ...)

getApp(nom)

Récupère une instance FirebaseApp .

Lorsqu'elle est appelée sans argument, l'application par défaut est renvoyée. Lorsqu'un nom d'application est fourni, l'application correspondant à ce nom est renvoyée.

Une exception est levée si l'application récupérée n'a pas encore été initialisée.

Signature:

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

Paramètres

Paramètre Taper Description
nom chaîne Nom facultatif de l’application à renvoyer. Si aucun nom n'est fourni, la valeur par défaut est "[DEFAULT]" .

Retour:

FirebaseApp

L'application correspondant au nom de l'application fourni. Si aucun nom d'application n'est fourni, l'application par défaut est renvoyée.

Exemple 1

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

Exemple 2

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

fonction(options, ...)

initializeApp (options, nom)

Crée et initialise une instance FirebaseApp .

Consultez Ajouter Firebase à votre application et Initialiser plusieurs projets pour une documentation détaillée.

Signature:

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

Paramètres

Paramètre Taper Description
choix Options Firebase Options pour configurer les services de l'application.
nom chaîne Nom facultatif de l’application à initialiser. Si aucun nom n'est fourni, la valeur par défaut est "[DEFAULT]" .

Retour:

FirebaseApp

L'application initialisée.

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

Exemple 2


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

initializeApp (options, configuration)

Crée et initialise une instance FirebaseApp.

Signature:

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

Paramètres

Paramètre Taper Description
choix Options Firebase Options pour configurer les services de l'application.
configuration Paramètres de l'application Firebase Configuration de l'application Firebase

Retour:

FirebaseApp

SDK_VERSION

La version actuelle du SDK.

Signature:

SDK_VERSION: string