firebase-admin.app package

Inicialización de la app y el SDK de Firebase.

Funciones

Función Descripción
applicationDefault(httpAgent) Muestra una credencial creada a partir de las credenciales predeterminadas de la aplicación de Google que otorga acceso de administrador a los servicios de Firebase. Esta credencial se puede usar en la llamada a initialApp().Las credenciales predeterminadas de la aplicación de Google están disponibles en cualquier infraestructura de Google, como Google App Engine y Google Compute Engine.Consulta Inicializa el SDK para obtener más detalles.
cert(serviceAccountPathOrObject, httpAgent) Devuelve una credencial creada a partir de la cuenta de servicio proporcionada que otorga acceso de administrador a los servicios de Firebase. Esta credencial se puede usar en la llamada a InitializeApp().Consulta Inicializa el SDK para obtener más detalles.
deleteApp(aplicación) Impide que se pueda usar App, dado que libera los recursos de todos los servicios asociados (aunque *no* limpia ningún recurso de backend). Cuando se ejecuta el SDK de manera local, se debe llamar a este método para garantizar la finalización correcta del proceso.
getApp(NombreDeApp)
getApps()
inicializarApp(opciones, appName)
refreshToken(refreshTokenPathOrObject, httpAgent) Devuelve una credencial creada a partir del token de actualización proporcionado que otorga acceso de administrador a los servicios de Firebase. Esta credencial se puede usar en la llamada a InitializeApp().Consulta Inicializa el SDK para obtener más detalles.

Clases

Clase Descripción
AppErrorCodes. Códigos de error del cliente de la app y sus mensajes predeterminados
FirebaseAppError. Estructura del código de error de la app de Firebase. Esto extiende PrefixedFirebaseError.

Interfaces

Interfaz Descripción
Aplicación Una app de Firebase contiene la información de inicialización para una colección de servicios.
Opciones de aplicación Opciones disponibles para pasar a InitializeApp().
Credentials Interfaz que proporciona tokens de acceso de Google OAuth2 que se usan para autenticar con los servicios de Firebase.En la mayoría de los casos, no necesitarás implementarlo por tu cuenta y, en su lugar, puedes usar las implementaciones predeterminadas que proporciona el módulo firebase-admin/app.
FirebaseArrayIndexError. Tipo compuesto que incluye un objeto FirebaseError y un índice que se puede usar para obtener el elemento con error.
FirebaseError. FirebaseError es una subclase del objeto Error estándar de JavaScript. Además de una cadena de mensaje y un seguimiento de pila, contiene un código de cadena.
GoogleOAuthAccessToken Interfaz para tokens de acceso de Google OAuth 2.0.
Cuenta de servicio

Variables

Variable Descripción
SDK_VERSION

applicationDefault(httpAgent)

Muestra una credencial creada a partir de las credenciales predeterminadas de la aplicación de Google que otorga acceso de administrador a los servicios de Firebase. Esta credencial se puede usar en la llamada a InitializeApp().

Las credenciales predeterminadas de la aplicación de Google están disponibles en cualquier infraestructura de Google, como Google App Engine y Google Compute Engine.

Consulta Inicializa el SDK para obtener más detalles.

Firma:

export declare function applicationDefault(httpAgent?: Agent): Credential;

Parámetros

Parámetro Tipo Descripción
httpAgent Agente El agente HTTP opcional que se usará cuando se recuperen los tokens de acceso de los servidores de tokens de Google.

Muestra:

Credentials

Una credencial autenticada a través de las credenciales predeterminadas de la aplicación de Google que se puede usar para inicializar una app.

Ejemplo

initializeApp({
  credential: applicationDefault(),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

cert(serviceAccountPathOrObject, httpAgent)

Devuelve una credencial creada a partir de la cuenta de servicio proporcionada que otorga acceso de administrador a los servicios de Firebase. Esta credencial se puede usar en la llamada a InitializeApp().

Consulta Inicializa el SDK para obtener más detalles.

Firma:

export declare function cert(serviceAccountPathOrObject: string | ServiceAccount, httpAgent?: Agent): Credential;

Parámetros

Parámetro Tipo Descripción
serviceAccountPathOrObject cadena | Cuenta de servicio La ruta de acceso a un archivo JSON de claves de cuenta de servicio o a un objeto que represente una clave de cuenta de servicio.
httpAgent Agente El agente HTTP opcional que se usará cuando se recuperen los tokens de acceso de los servidores de tokens de Google.

Muestra:

Credentials

Una credencial autenticada a través de la cuenta de servicio proporcionada que se puede usar para inicializar una app.

Ejemplo 1

// Providing a path to a service account key JSON file
const serviceAccount = require("path/to/serviceAccountKey.json");
initializeApp({
  credential: cert(serviceAccount),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

Ejemplo 2

// Providing a service account object inline
initializeApp({
  credential: cert({
    projectId: "<PROJECT_ID>",
    clientEmail: "foo@<PROJECT_ID>.iam.gserviceaccount.com",
    privateKey: "-----BEGIN PRIVATE KEY-----<KEY>-----END PRIVATE KEY-----\n"
  }),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

deleteApp(aplicación)

Impide que se pueda usar App, dado que libera los recursos de todos los servicios asociados (aunque *no* limpia ningún recurso de backend). Cuando se ejecuta el SDK de manera local, se debe llamar a este método para garantizar la finalización correcta del proceso.

Firma:

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

Parámetros

Parámetro Tipo Descripción
app Aplicación

Muestra:

Promesa<void>

Ejemplo

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

getApp(nombredeaplicación)

Firma:

export declare function getApp(appName?: string): App;

Parámetros

Parámetro Tipo Descripción
appName string

Muestra:

Aplicación

getApps()

Firma:

export declare function getApps(): App[];

Muestra:

Aplicación

inicializarApp(opciones, nombreapp)

Firma:

export declare function initializeApp(options?: AppOptions, appName?: string): App;

Parámetros

Parámetro Tipo Descripción
opciones Opciones de aplicación
appName string

Muestra:

Aplicación

updateToken(refreshTokenPathOrObject, httpAgent)

Devuelve una credencial creada a partir del token de actualización proporcionado que otorga acceso de administrador a los servicios de Firebase. Esta credencial se puede usar en la llamada a InitializeApp().

Consulta Inicializa el SDK para obtener más detalles.

Firma:

export declare function refreshToken(refreshTokenPathOrObject: string | object, httpAgent?: Agent): Credential;

Parámetros

Parámetro Tipo Descripción
actualizarTokenPathOrObject cadena | objeto La ruta de acceso a un archivo JSON de token de actualización de Google OAuth2 o a un objeto que representa un token de actualización de Google OAuth2.
httpAgent Agente El agente HTTP opcional que se usará cuando se recuperen los tokens de acceso de los servidores de tokens de Google.

Muestra:

Credentials

Una credencial autenticada a través de la cuenta de servicio proporcionada que se puede usar para inicializar una app.

Ejemplo

// Providing a path to a refresh token JSON file
const refreshToken = require("path/to/refreshToken.json");
initializeApp({
  credential: refreshToken(refreshToken),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

SDK_VERSION

Firma:

SDK_VERSION: string