firebase-admin.app package

Inicialización del SDK y la aplicación Firebase.

Funciones

Función Descripción
aplicación predeterminada (httpAgent) Devuelve 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 utilizar en la llamada a inicializarApp() . Las credenciales predeterminadas de aplicaciones de Google están disponibles en cualquier infraestructura de Google, como Google App Engine y Google Compute Engine. Consulte Inicializar 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 utilizar en la llamada a inicializarApp() . Consulte Inicializar el SDK para obtener más detalles.
eliminar aplicación (aplicación) Inutiliza esta App determinada y libera los recursos de todos los servicios asociados (aunque *no* limpia ningún recurso de backend). Cuando se ejecuta el SDK localmente, se debe llamar a este método para garantizar una finalización correcta del proceso.
getApp(nombre de la aplicación)
obtener aplicaciones()
inicializar aplicación (opciones, nombre de aplicación)
actualizarToken(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 utilizar en la llamada a inicializarApp() . Consulte Inicializar el SDK para obtener más detalles.

Interfaces

Interfaz Descripción
Aplicación Una aplicación de Firebase contiene la información de inicialización de una colección de servicios.
Opciones de aplicación Opciones disponibles para pasar a inicializarApp() .
Credencial Interfaz que proporciona tokens de acceso de Google OAuth2 utilizados para autenticarse con los servicios de Firebase. En la mayoría de los casos, no necesitará implementar esto usted mismo y, en su lugar, puede usar las implementaciones predeterminadas proporcionadas por el módulo firebase-admin/app .
Error de índice de matriz de Firebase Tipo compuesto que incluye un objeto FirebaseError y un índice que se puede usar para obtener el elemento con error.
Error de base de fuego FirebaseError es una subclase del objeto Error de JavaScript estándar. Además de una cadena de mensaje y un seguimiento de la pila, contiene un código de cadena.
Token de acceso de GoogleOAuth Interfaz para tokens de acceso de Google OAuth 2.0.
Cuenta de servicio

variables

Variable Descripción
SDK_VERSION

aplicación predeterminada()

Devuelve 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 utilizar en la llamada a inicializarApp() .

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

Consulte Inicializar el SDK para obtener más detalles.

Firma:

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

Parámetros

Parámetro Tipo Descripción
httpAgente Agente Agente HTTP opcional que se utilizará al recuperar tokens de acceso de los servidores de tokens de Google.

Devoluciones:

Credencial

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

Ejemplo

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

certificado()

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 utilizar en la llamada a inicializarApp() .

Consulte Inicializar 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 a un archivo JSON de clave de cuenta de servicio o un objeto que representa una clave de cuenta de servicio.
httpAgente Agente Agente HTTP opcional que se utilizará al recuperar tokens de acceso de los servidores de tokens de Google.

Devoluciones:

Credencial

Una credencial autenticada a través de la cuenta de servicio proporcionada que se puede utilizar para inicializar una aplicación.

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

eliminar aplicación()

Inutiliza esta App determinada y libera los recursos de todos los servicios asociados (aunque *no* limpia ningún recurso de backend). Cuando se ejecuta el SDK localmente, se debe llamar a este método para garantizar una finalización correcta del proceso.

Firma:

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

Parámetros

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

Devoluciones:

Promesa<nulo>

Ejemplo

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

Obtener aplicaciones()

Firma:

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

Parámetros

Parámetro Tipo Descripción
nombre de la aplicación cadena

Devoluciones:

Aplicación

obtener aplicaciones()

Firma:

export declare function getApps(): App[];

Devoluciones:

Aplicación []

inicializar aplicación()

Firma:

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

Parámetros

Parámetro Tipo Descripción
opciones Opciones de aplicación
nombre de la aplicación cadena

Devoluciones:

Aplicación

actualizarToken()

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 utilizar en la llamada a inicializarApp() .

Consulte Inicializar 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 a un archivo JSON del token de actualización de Google OAuth2 o un objeto que representa un token de actualización de Google OAuth2.
httpAgente Agente Agente HTTP opcional que se utilizará al recuperar tokens de acceso de los servidores de tokens de Google.

Devoluciones:

Credencial

Una credencial autenticada a través de la cuenta de servicio proporcionada que se puede utilizar para inicializar una aplicación.

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