app package

App de Firebase

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

Funciones

Función Descripción
function(app, ...)
deleteApp(app) Inutiliza esta app y libera los recursos de todos los servicios asociados.
función()
getApps() Un array (solo lectura) de todas las apps inicializadas.
initializeApp() Crea y, luego, inicializa una instancia de FirebaseApp.
function(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, version, variant) 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 registros superiores al nivel de registro actual (es decir, si configuras el nivel de registro en info, se registran errores, pero no los registros debug y verbose).
function(name, ...)
getApp(nombre) Recupera una instancia de FirebaseApp.Cuando se la llama sin argumentos, se muestra la app predeterminada. Cuando se proporciona un nombre de app, se muestra la app correspondiente a ese nombre.Se arroja una excepción si aún no se inicializa la app que se está recuperando.
function(options, ...)
InitializeApp(options, name) Crea y, luego, inicializa una instancia de FirebaseApp.Consulta Cómo agregar Firebase a tu app e Inicializa varios proyectos para ver la documentación detallada.
InitializeApp(options, Config) Crea y, luego, inicializa una instancia de FirebaseApp.
InitializeServerApp(options, config) Crea e inicializa una instancia de FirebaseServerApp.FirebaseServerApp es similar a FirebaseApp, pero está diseñada para ejecutarse únicamente 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 y, luego, Inicializa varios proyectos para obtener documentación detallada.

Interfaces

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

Variables

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

función(app, ...)

borrarApp(aplicación)

Inutiliza esta app y libera los recursos de todos los servicios asociados.

Signature:

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

Parámetros

Parámetro Tipo Descripción
app FirebaseApp

Devuelve:

Promise<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 (solo lectura) de todas las apps inicializadas.

Signature:

export declare function getApps(): FirebaseApp[];

Devuelve:

FirebaseApp[]

initializeApp()

Crea y, luego, inicializa una instancia de FirebaseApp.

Signature:

export declare function initializeApp(): FirebaseApp;

Devuelve:

FirebaseApp

función(libraryKeyOrName, ...)

registerVersion(libraryKeyOrName, version, variant)

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

Signature:

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

Parámetros

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

Devuelve:

void

función(logCallback, ...)

onLog(logCallback, opciones)

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

Signature:

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

Parámetros

Parámetro Tipo Descripción
logCallback LogCallback | nulo Controlador de registro personalizado opcional que ejecuta el código del usuario cada vez que el SDK de Firebase realiza una llamada de registro.
Opciones LogOptions

Devuelve:

void

función(logLevel, ...)

setLogLevel(logLevel)

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

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

Signature:

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

Parámetros

Parámetro Tipo Descripción
logLevel LogLevelString

Devuelve:

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 correspondiente a ese nombre.

Si la app recuperada aún no se inicializa, se genera una excepción.

Signature:

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

Parámetros

Parámetro Tipo Descripción
name cadena Nombre opcional de la app que se mostrará. Si no se proporciona un nombre, el valor predeterminado es "[DEFAULT]".

Devuelve:

FirebaseApp

La app que corresponde 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, ...)

inicializaApp(opciones, nombre)

Crea y, luego, inicializa una instancia de FirebaseApp.

Consulta Agrega Firebase a tu app y, luego, Inicializa varios proyectos para obtener la documentación detallada.

Signature:

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

Parámetros

Parámetro Tipo Descripción
Opciones FirebaseOptions Opciones para configurar los servicios de la app.
name cadena Nombre opcional de la app que se inicializará. Si no se proporciona un nombre, el valor predeterminado es "[DEFAULT]".

Devuelve:

FirebaseApp

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

inicializaApp(opciones, configuración)

Crea y, luego, inicializa una instancia de FirebaseApp.

Signature:

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

Parámetros

Parámetro Tipo Descripción
Opciones FirebaseOptions Opciones para configurar los servicios de la app.
config FirebaseAppSettings Configuración de FirebaseApp

Devuelve:

FirebaseApp

inicializaServerApp(opciones, configuración)

Crea e inicializa una instancia FirebaseServerApp.

FirebaseServerApp es similar a FirebaseApp, pero está diseñado para ejecutarse únicamente 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 y, luego, Inicializa varios proyectos para obtener la documentación detallada.

Signature:

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

Parámetros

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

Devuelve:

FirebaseServerApp

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.

Signature:

SDK_VERSION: string