Application Firebase
Ce package coordonne la communication entre les différents composants de Firebase.
Fonctions
| Fonction | Description |
|---|---|
| fonction(application, ...) | |
| deleteApp(app) | Rend cette application inutilisable et libère les ressources de tous les services associés. |
| fonction() | |
| getApps() | Tableau (lecture seule) de toutes les applications initialisées. |
| initializeApp() | Crée et initialise une instance FirebaseApp. |
| function(libraryKeyOrName, ...) (fonction(bibliothèqueCléOrName, ...)) | |
| registerVersion(libraryKeyOrName, version, variant) | Enregistre le nom et la version d'une bibliothèque à des fins de journalisation de la plate-forme. |
| function(logCallback, ...). | |
| onLog(logCallback, options). | Définit le gestionnaire de journaux pour tous les SDK Firebase. |
| function(logLevel, ...) (Niveau de journalisation, ...) | |
| setLogLevel(logLevel) | Définit le niveau de journalisation pour tous les SDK Firebase.Tous les types de journaux supérieurs au niveau de journalisation actuel sont capturés (par exemple, si vous définissez le niveau de journalisation sur info, les erreurs sont consignées, mais pas les journaux debug et verbose). |
| function(nom, ...) | |
| getApp(nom) | Récupère une instance FirebaseApp.En cas d'appel 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 générée si l'application en cours de récupération n'a pas encore été initialisée. |
| function(options, ...) | |
| initialiserApp(options, name) | Crée et initialise une instance FirebaseApp.Pour en savoir plus, consultez Ajouter Firebase à votre application et Initialiser plusieurs projets. |
| initialApp(options, config). | Crée et initialise une instance FirebaseApp. |
| initialServerApp(options, config) | Crée et initialise une instance FirebaseServerApp.Le FirebaseServerApp est semblable à FirebaseApp, mais est destiné à être exécuté uniquement dans les environnements de rendu côté serveur. L'initialisation échoue si elle est appelée depuis un environnement de navigateur.Pour en savoir plus, consultez Ajouter Firebase à votre application et Initialiser plusieurs projets. |
Interfaces
| Interface | Description |
|---|---|
| FirebaseApp | Un FirebaseApp contient les informations d'initialisation pour un ensemble de services.N'appelez pas ce constructeur directement. Utilisez plutôt initializeApp() pour créer une application. |
| FirebaseAppSettings | Options de configuration fournies pour initializeApp() |
| FirebaseOptions | Objet de configuration Firebase. Contient un ensemble de paramètres requis par les services pour communiquer avec les API du serveur Firebase, et pour associer les données client à votre projet et votre application Firebase. Généralement, cet objet est renseigné par la console Firebase lors de la configuration du projet. Consultez également En savoir plus sur l'objet de configuration Firebase. |
| FirebaseServerApp | Un FirebaseServerApp contient les informations d'initialisation pour un ensemble de services exécutés dans des environnements de serveur.N'appelez pas ce constructeur directement. Utilisez plutôt initialServerApp() pour créer une application. |
| FirebaseServerAppSettings | Options de configuration fournies pour initialServerApp() |
Variables
| Variable | Description |
|---|---|
| SDK_VERSION | Version actuelle du SDK. |
fonction(app, ...)
deleteApp(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ètres | Type | Description |
|---|---|---|
| appli | FirebaseApp |
Renvoie :
Promise<void>
Exemple
deleteApp(app)
.then(function() {
console.log("App deleted successfully");
})
.catch(function(error) {
console.log("Error deleting app:", error);
});
fonction()
getApps()
Tableau (lecture seule) de toutes les applications initialisées.
Signature :
export declare function getApps(): FirebaseApp[];
Renvoie :
initializeApp()
Crée et initialise une instance FirebaseApp.
Signature :
export declare function initializeApp(): FirebaseApp;
Renvoie :
fonction(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, version, variant)
Enregistre le nom et la version d'une bibliothèque à des fins de journalisation de la plate-forme.
Signature :
export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
Paramètres
| Paramètres | Type | Description |
|---|---|---|
| libraryKeyOrName | chaîne | |
| version | chaîne | Version actuelle de cette bibliothèque. |
| variant | chaîne | Variante du bundle, par exemple node, rn, etc. |
Renvoie :
void
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ètres | Type | Description |
|---|---|---|
| logCallback | LogCallback | null | Gestionnaire de journaux personnalisés facultatif qui exécute le code utilisateur chaque fois que le SDK Firebase effectue un appel de journalisation. |
| options | LogOptions |
Renvoie :
void
function(logLevel, ...)
setLogLevel(logLevel)
Définit le niveau de journalisation pour tous les SDK Firebase.
Tous les types de journaux supérieurs au niveau actuel sont capturés (par exemple, si vous définissez le niveau de journalisation sur info, les erreurs sont consignées, mais pas les journaux debug et verbose).
Signature :
export declare function setLogLevel(logLevel: LogLevelString): void;
Paramètres
| Paramètres | Type | Description |
|---|---|---|
| logLevel | LogLevelString |
Renvoie :
void
fonction(nom, ...)
getApp(nom)
Récupère une instance FirebaseApp.
En cas d'appel 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 générée si l'application en cours de récupération n'a pas encore été initialisée.
Signature :
export declare function getApp(name?: string): FirebaseApp;
Paramètres
| Paramètres | Type | Description |
|---|---|---|
| name | chaîne | Nom facultatif de l'application à renvoyer. Si aucun nom n'est fourni, la valeur par défaut est "[DEFAULT]". |
Renvoie :
Application correspondant au nom d'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, ...)
initialiserApp(options, nom)
Crée et initialise une instance FirebaseApp.
Pour en savoir plus, consultez Ajouter Firebase à votre application et Initialiser plusieurs projets.
Signature :
export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
Paramètres
| Paramètres | Type | Description |
|---|---|---|
| options | FirebaseOptions | Options permettant de configurer les services de l'application. |
| name | chaîne | Nom facultatif de l'application à initialiser. Si aucun nom n'est fourni, la valeur par défaut est "[DEFAULT]". |
Renvoie :
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");
initialiserApp(options, config)
Crée et initialise une instance FirebaseApp.
Signature :
export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
Paramètres
| Paramètres | Type | Description |
|---|---|---|
| options | FirebaseOptions | Options permettant de configurer les services de l'application. |
| config | FirebaseAppSettings | Configuration de FirebaseApp |
Renvoie :
initialiserServerApp(options, configuration)
Crée et initialise une instance FirebaseServerApp.
FirebaseServerApp est semblable à FirebaseApp, mais est destiné à être exécuté uniquement dans des environnements de rendu côté serveur. L'initialisation échoue si elle est appelée depuis un environnement de navigateur.
Pour en savoir plus, consultez Ajouter Firebase à votre application et Initialiser plusieurs projets.
Signature :
export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
Paramètres
| Paramètres | Type | Description |
|---|---|---|
| options | FirebaseOptions | FirebaseApp | Firebase.AppOptions pour configurer les services de l'application, ou une instance FirebaseApp contenant le AppOptions. |
| config | FirebaseServerAppSettings | Configuration de FirebaseServerApp. |
Renvoie :
Le FirebaseServerApp initialisé.
Exemple
// 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
Version actuelle du SDK.
Signature :
SDK_VERSION: string