app package

Aplicación Firebase

Este paquete coordina la comunicación entre los diferentes componentes de Firebase.

Funciones

Función Descripción
función (aplicación, ...)
eliminar aplicación (aplicación) Inutiliza esta aplicación y libera los recursos de todos los servicios asociados.
función()
obtener aplicaciones() Una matriz (de solo lectura) de todas las aplicaciones inicializadas.
inicializar aplicación() Crea e inicializa una instancia de FirebaseApp.
función(bibliotecaClaveONombre, ...)
registrarVersión(bibliotecaClaveONombre, versión, variante) Registra el nombre y la versión de una biblioteca para fines de registro de la plataforma.
función (logCallback, ...)
onLog(logCallback, opciones) Establece el controlador de registros para todos los SDK de Firebase.
función (nivel de registro, ...)
setLogLevel(logLevel) Establece el nivel de registro para todos los SDK de Firebase. Se capturan todos los tipos de registro por encima del nivel de registro actual (es decir, si configura el nivel de registro en info , se registran los errores, pero no los registros debug y verbose ).
nombre de la función, ...)
obtener aplicación (nombre) Recupera una instancia de FirebaseApp . Cuando se llama sin argumentos, se devuelve la aplicación predeterminada. Cuando se proporciona el nombre de una aplicación, se devuelve la aplicación correspondiente a ese nombre. Se produce una excepción si la aplicación que se recupera aún no se ha inicializado.
función(opciones,...)
inicializarApp(opciones, nombre) Crea e inicializa una instancia de FirebaseApp . Consulta Agregar Firebase a tu aplicación e Inicializar varios proyectos para obtener documentación detallada.
inicializar aplicación (opciones, configuración) Crea e inicializa una instancia de FirebaseApp.

Interfaces

Interfaz Descripción
Aplicación Firebase Una FirebaseApp contiene la información de inicialización de una colección de servicios. No llame a este constructor directamente. En su lugar, utilice inicializeApp() para crear una aplicación.
Configuración de FirebaseApp Opciones de configuración dadas a inicializarApp()
Opciones de Firebase Objeto de configuración de Firebase. Contiene un conjunto de parámetros requeridos por los servicios para comunicarse correctamente con las API del servidor de Firebase y asociar los datos del cliente con su proyecto de Firebase y su aplicación de Firebase. Normalmente, este objeto lo completa Firebase console durante la configuración del proyecto. Ver también: Obtenga más información sobre el objeto de configuración de Firebase .

variables

Variable Descripción
SDK_VERSION La versión actual del SDK.

función (aplicación, ...)

eliminar aplicación (aplicación)

Inutiliza esta aplicación y libera los recursos de todos los servicios asociados.

Firma:

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

Parámetros

Parámetro Tipo Descripción
aplicación Aplicación Firebase

Devoluciones:

Promesa<nulo>

Ejemplo

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

función()

obtener aplicaciones()

Una matriz (de solo lectura) de todas las aplicaciones inicializadas.

Firma:

export declare function getApps(): FirebaseApp[];

Devoluciones:

Aplicación Firebase []

inicializar aplicación()

Crea e inicializa una instancia de FirebaseApp.

Firma:

export declare function initializeApp(): FirebaseApp;

Devoluciones:

Aplicación Firebase

función(bibliotecaClaveONombre, ...)

registrarVersión(bibliotecaClaveONombre, versión, variante)

Registra el nombre y la versión de una biblioteca para fines de registro de la plataforma.

Firma:

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

Parámetros

Parámetro Tipo Descripción
bibliotecaClaveONombre cadena
versión cadena Versión actual de esa biblioteca.
variante cadena Variante de paquete, por ejemplo, nodo, rn, etc.

Devoluciones:

vacío

función (logCallback, ...)

onLog(logCallback, opciones)

Establece el controlador de registros para todos los SDK de Firebase.

Firma:

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

Parámetros

Parámetro Tipo Descripción
registrarDevolución de llamada Registro de devolución de llamada | nulo Un controlador de registro personalizado opcional que ejecuta código de usuario cada vez que el SDK de Firebase realiza una llamada de registro.
opciones Opciones de registro

Devoluciones:

vacío

función (nivel de registro, ...)

setLogLevel(logLevel)

Establece el nivel de registro para todos los SDK de Firebase.

Se capturan todos los tipos de registro por encima del nivel de registro actual (es decir, si configura el nivel de registro en info , los errores se registran, pero los registros debug y verbose no).

Firma:

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

Parámetros

Parámetro Tipo Descripción
nivel de registro cadena de nivel de registro

Devoluciones:

vacío

nombre de la función, ...)

obtener aplicación (nombre)

Recupera una instancia de FirebaseApp .

Cuando se llama sin argumentos, se devuelve la aplicación predeterminada. Cuando se proporciona el nombre de una aplicación, se devuelve la aplicación correspondiente a ese nombre.

Se produce una excepción si la aplicación que se recupera aún no se ha inicializado.

Firma:

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

Parámetros

Parámetro Tipo Descripción
nombre cadena Nombre opcional de la aplicación a devolver. Si no se proporciona ningún nombre, el valor predeterminado es "[DEFAULT]" .

Devoluciones:

Aplicación Firebase

La aplicación correspondiente al nombre de la aplicación proporcionada. Si no se proporciona ningún nombre de aplicación, se devuelve la aplicación predeterminada.

Ejemplo 1

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

Ejemplo 2

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

función(opciones,...)

inicializarApp(opciones, nombre)

Crea e inicializa una instancia de FirebaseApp .

Consulta Agregar Firebase a tu aplicación e Inicializar varios proyectos para obtener documentación detallada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
opciones Opciones de Firebase Opciones para configurar los servicios de la aplicación.
nombre cadena Nombre opcional de la aplicación a inicializar. Si no se proporciona ningún nombre, el valor predeterminado es "[DEFAULT]" .

Devoluciones:

Aplicación Firebase

La aplicación inicializada.

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

Ejemplo 2


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

inicializar aplicación (opciones, configuración)

Crea e inicializa una instancia de FirebaseApp.

Firma:

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

Parámetros

Parámetro Tipo Descripción
opciones Opciones de Firebase Opciones para configurar los servicios de la aplicación.
configuración Configuración de FirebaseApp Configuración de la aplicación Firebase

Devoluciones:

Aplicación Firebase

SDK_VERSION

La versión actual del SDK.

Firma:

SDK_VERSION: string