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) Hace que esta aplicación quede inutilizable y libera los recursos de todos los servicios asociados.
función()
obtener aplicaciones () Una matriz (de solo lectura) de todas las aplicaciones inicializadas.
inicializarAplicación() Crea e inicializa una instancia de FirebaseApp.
function(bibliotecaClaveONombre...)
registerVersion(libraryKeyOrName, 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...)
establecer nivel de registro (nivel de registro) 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 establece el nivel de registro en info , se registran los errores, pero no los registros verbose y de debug ).
nombre de la función...)
getApp(nombre) Recupera una instancia de FirebaseApp . Cuando se llama sin argumentos, se devuelve la aplicación predeterminada. Cuando se proporciona un nombre de aplicación, se devuelve la aplicación correspondiente a ese nombre. Se genera una excepción si la aplicación que se está recuperando aún no se ha inicializado.
función(opciones...)
initializeApp(opciones, nombre) Crea e inicializa una instancia de FirebaseApp . Consulte Agregar Firebase a su aplicación e Inicializar varios proyectos para obtener documentación detallada.
initializeApp(opciones, configuración) Crea e inicializa una instancia de FirebaseApp.

Interfaces

Interfaz Descripción
FirebaseApp 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 initializeApp() para crear una aplicación.
Configuración de FirebaseApp Opciones de configuración dadas a initializeApp()
FirebaseOptions 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 para asociar los datos del cliente con su proyecto de Firebase y su aplicación de Firebase. Por lo general, Firebase console completa este objeto en la configuración del proyecto. Ver también: Más información sobre el objeto de configuración de Firebase .

Variables

Variable Descripción
SDK_VERSIÓN La versión actual del SDK.

eliminarAplicación()

Hace que esta aplicación quede inutilizable y libera los recursos de todos los servicios asociados.

Firma:

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

Parámetros

Parámetro Escribe Descripción
aplicación FirebaseApp

Devoluciones:

Promesa <vacío>

Ejemplo

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

obtener aplicaciones ()

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

Firma:

export declare function getApps(): FirebaseApp[];

Devoluciones:

FirebaseApp []

inicializarAplicación()

Crea e inicializa una instancia de FirebaseApp.

Firma:

export declare function initializeApp(): FirebaseApp;

Devoluciones:

FirebaseApp

registrarseVersión()

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 Escribe Descripción
bibliotecaClaveONombre cuerda
versión cuerda Versión actual de esa biblioteca.
variante cuerda Variante de paquete, por ejemplo, nodo, rn, etc.

Devoluciones:

vacío

onLog()

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 Escribe Descripción
registroCallback LogCallback | nulo Un controlador de registro personalizado opcional que ejecuta el código de usuario cada vez que el SDK de Firebase realiza una llamada de registro.
opciones Opciones de registro

Devoluciones:

vacío

establecer nivel de registro ()

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 establece el nivel de registro en info , se registran los errores, pero no los registros verbose y de debug ).

Firma:

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

Parámetros

Parámetro Escribe Descripción
nivel de registro LogLevelString

Devoluciones:

vacío

Obtener aplicaciones()

Recupera una instancia de FirebaseApp .

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

Se genera una excepción si la aplicación que se está recuperando aún no se ha inicializado.

Firma:

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

Parámetros

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

Devoluciones:

FirebaseApp

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

inicializarAplicación()

Crea e inicializa una instancia de FirebaseApp .

Consulte Agregar Firebase a su 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 Escribe Descripción
opciones FirebaseOptions Opciones para configurar los servicios de la aplicación.
nombre cuerda Nombre opcional de la aplicación para inicializar. Si no se proporciona ningún nombre, el valor predeterminado es "[DEFAULT]" .

Devoluciones:

FirebaseApp

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

inicializarAplicación()

Crea e inicializa una instancia de FirebaseApp.

Firma:

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

Parámetros

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

Devoluciones:

FirebaseApp

SDK_VERSIÓN

La versión actual del SDK.

Firma:

SDK_VERSION: string