Se usó la API de Cloud Translation para traducir esta página.

app package

App de Firebase

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

Funciones

Función	Descripción
function(app, ...)
deleteApp(aplicación)	Inutiliza esta app y libera los recursos de todos los servicios asociados.
function()
getApps()	Un array (de solo lectura) de todas las apps inicializadas
inicializarApp()	Crea e inicializa una instancia de FirebaseApp.
function(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, versión, variante)	Registra el nombre y la versión de una biblioteca para fines de registro de plataforma.
function(logCallback, ...)
onLog(logCallback, opciones)	Configura el controlador de registros para todos los SDK de Firebase.
function(logLevel, ...)
setLogLevel(logLevel)	Establece el nivel de registro para todos los SDK de Firebase.Se capturan todos los tipos de registro que se encuentran por encima del nivel de registro actual (es decir, si estableces el nivel de registro en `info`, se registrarán errores, pero los registros `debug` y `verbose` no).
function(name, ...)
getApp(nombre)	Recupera una instancia de FirebaseApp.Cuando se llama sin argumentos, se muestra la app predeterminada. Cuando se proporciona un nombre de app, se muestra la app que le corresponde.Se arroja una excepción si aún no se inicializó la app que se estaba recuperando.
function(options, ...)
inicializaApp(opciones, nombre)	Crea y, luego, inicializa una instancia de FirebaseApp.Para obtener documentación detallada, consulta Agrega Firebase a tu app y Inicializa varios proyectos.
inicializaApp(opciones, config)	Crea e inicializa una instancia de FirebaseApp.
inicializarServerApp(opciones, config)	Crea y, luego, inicializa una instancia FirebaseServerApp.`FirebaseServerApp` es similar a `FirebaseApp`, pero está diseñada para ejecutarse solo en entornos de renderización del servidor. La inicialización fallará si se invoca desde un entorno de navegador.Consulta Agrega Firebase a tu app e Inicializa varios proyectos para obtener documentación detallada.

Interfaces

Interfaz	Descripción
App de Firebase	Una FirebaseApp contiene la información de inicialización para un conjunto de servicios.No llames a este constructor directamente. En su lugar, usa InitializeApp() para crear una app.
FirebaseAppSettings	Opciones de configuración otorgadas a inicializadora()
Opciones de Firebase	objeto de configuración de Firebase. Contiene un conjunto de parámetros que requieren los servicios para comunicarse correctamente con las APIs del servidor de Firebase y asociar los datos de clientes con tu proyecto y aplicación de Firebase. Por lo general, Firebase console propaga este objeto durante la configuración del proyecto. Consulta también: Obtén información sobre el objeto de configuración de Firebase.
FirebaseServerApp.	Una FirebaseServerApp contiene la información de inicialización para un conjunto de servicios que se ejecutan en entornos de servidor.No llames directamente a este constructor. En su lugar, usa InitializeServerApp() para crear una app.
FirebaseServerAppSettings	Opciones de configuración otorgadas a initialServerApp()

Variables

Variable	Descripción
SDK_VERSION	Es la versión actual del SDK.

función(app, ...)

deleteApp(aplicación)

Inutiliza esta app 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
app	App de Firebase

Muestra:

Promesa<void>

Ejemplo

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

función()

getApps()

Un array (de solo lectura) de todas las apps inicializadas

Firma:

export declare function getApps(): FirebaseApp[];

Muestra:

FirebaseApp

inicializaApp()

Crea e inicializa una instancia de FirebaseApp.

Firma:

export declare function initializeApp(): FirebaseApp;

Muestra:

App de Firebase

función(libraryKeyOrName, ...)

registerVersion(libraryKeyOrName, versión, variante)

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

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
ClaveONombredebiblioteca	string
versión	string	Es la versión actual de esa biblioteca.
variant	string	Variante del paquete, p. ej., nodo, rn, etcétera

Muestra:

void

función(logCallback, ...)

onLog(logCallback, opciones)

Configura 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
Devolución de llamada de log	Devolución de llamada de registro \| nulo	Un controlador de registros personalizado opcional que ejecuta el código del usuario cada vez que el SDK de Firebase realiza una llamada de registro.
opciones	Opciones de registro

Muestra:

void

función(logLevel, ...)

setLogLevel(logLevel)

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

Se capturan todos los tipos de registro que están por encima del nivel de registro actual (es decir, si estableces el nivel de registro en info, se registrarán los errores, pero los registros debug y verbose no).

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
logLevel	Cadena de nivel de registro

Muestra:

void

función(nombre, ...)

getApp(nombre)

Recupera una instancia de FirebaseApp.

Cuando se llama sin argumentos, se muestra la app predeterminada. Cuando se proporciona un nombre de app, se muestra la app que le corresponde.

Se arrojará una excepción si aún no se inicializó la app recuperada.

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
nombre	string	Es el nombre opcional de la app que se muestra. Si no se proporciona ningún nombre, el valor predeterminado es `"[DEFAULT]"`.

Muestra:

App de Firebase

La app correspondiente al nombre de app proporcionado. Si no se proporciona un nombre de app, se muestra la app 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 y, luego, inicializa una instancia de FirebaseApp.

Para obtener documentación detallada, consulta Agrega Firebase a tu app y, además, Inicializa varios proyectos.

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 app.
nombre	string	Nombre opcional de la app que se inicializará. Si no se proporciona ningún nombre, el valor predeterminado es `"[DEFAULT]"`.

Muestra:

App de Firebase

Es la app 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");

inicializarApp(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 app.
config	FirebaseAppSettings	Configuración de FirebaseApp

Muestra:

App de Firebase

inicializaServerApp(opciones, configuración)

Crea y, luego, inicializa una instancia FirebaseServerApp.

FirebaseServerApp es similar a FirebaseApp, pero solo está diseñado para ejecutarse en entornos de renderización del servidor. La inicialización fallará si se invoca desde un entorno de navegador.

Para obtener documentación detallada, consulta Agrega Firebase a tu app y, además, Inicializa varios proyectos.

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
opciones	FirebaseOptions \| App de Firebase	`Firebase.AppOptions` para configurar los servicios de la app o una instancia de `FirebaseApp` que contenga el `AppOptions` dentro de ella.
config	FirebaseServerAppSettings	Configuración de `FirebaseServerApp`.

Muestra:

FirebaseServerApp.

Es el FirebaseServerApp inicializado.

Ejemplo


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

Es la versión actual del SDK.

Firma:

SDK_VERSION: string