firebase-admin.app package

Inicialização do app e do SDK do Firebase.

Funções

Função Descrição
applicationDefault(httpAgent) (em inglês) Retorna uma credencial criada com base nas Application Default Credentials do Google para conceder acesso de administrador aos serviços do Firebase. Essa credencial pode ser usada na chamada para initialApp().O Application Default Credentials do Google está disponível em qualquer infraestrutura do Google, como o Google App Engine e o Google Compute Engine.Consulte Inicializar o SDK para mais detalhes.
cert(serviceAccountPathOrObject, httpAgent) Retorna uma credencial criada a partir da conta de serviço fornecida que concede acesso de administrador aos serviços do Firebase. Essa credencial pode ser usada na chamada para InitializeApp().Consulte Inicializar o SDK para mais detalhes.
deleteApp(app) (link em inglês) Renderiza esse App inutilizável e libera os recursos de todos os serviços associados, embora *não* limpe nenhum recurso de back-end. Ao executar o SDK localmente, esse método precisa ser chamado para garantir o encerramento sem dificuldades do processo.
getApp(nomedoapp) (link em inglês)
getApps().
inicializarApp(opções, appName)
refreshToken(refreshTokenPathOrObject, httpAgent) Retorna uma credencial criada a partir do token de atualização fornecido que concede acesso de administrador aos serviços do Firebase. Essa credencial pode ser usada na chamada para InitializeApp().Consulte Inicializar o SDK para mais detalhes.

Classes

Turma Descrição
AppErrorCodes (link em inglês) Códigos de erro do cliente do app e as mensagens padrão deles
FirebaseAppError (em inglês) Estrutura do código de erro do app Firebase. Isso estende PrefixedFirebaseError.

Interfaces

Interface Descrição
App Um app do Firebase contém as informações de inicialização de uma coleção de serviços.
AppOptions (em inglês) Opções disponíveis para transmitir para InitializeApp().
Credential Interface que fornece tokens de acesso do Google OAuth2 usados para autenticação com os serviços do Firebase.Na maioria dos casos, não é necessário implementar isso por conta própria. Em vez disso, você pode usar as implementações padrão fornecidas pelo módulo firebase-admin/app.
FirebaseArrayIndexError Tipo composto que inclui um objeto FirebaseError e um índice que pode ser usado para receber o item com erro.
FirebaseError (em inglês) FirebaseError é uma subclasse do objeto JavaScript Error padrão. Além de uma string de mensagem e um stack trace, ele contém um código de string.
GoogleOAuthAccessToken (em inglês) Interface para tokens de acesso do Google OAuth 2.0.
ServiceAccount (em inglês)

Variáveis

Variável Descrição
SDK_VERSION (em inglês)

applicationDefault(httpAgent)

Retorna uma credencial criada com base nas Application Default Credentials do Google para conceder acesso de administrador aos serviços do Firebase. Essa credencial pode ser usada na chamada para InitializeApp().

O Application Default Credentials do Google está disponível em qualquer infraestrutura do Google, como Google App Engine e Google Compute Engine.

Consulte Inicializar o SDK para mais detalhes.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
Agente HTTP Agente Agente HTTP opcional a ser usado na recuperação de tokens de acesso dos servidores de token do Google.

Retorna:

Credential

Uma credencial autenticada pelo Application Default Credentials do Google que pode ser usada para inicializar um app.

Exemplo

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

cert(serviceAccountPathOrObject, httpAgent)

Retorna uma credencial criada a partir da conta de serviço fornecida que concede acesso de administrador aos serviços do Firebase. Essa credencial pode ser usada na chamada para InitializeApp().

Consulte Inicializar o SDK para mais detalhes.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
serviceAccountPathOrObject string | ServiceAccount (em inglês) O caminho para um arquivo JSON de chave de conta de serviço ou um objeto que representa uma chave de conta de serviço.
Agente HTTP Agente Agente HTTP opcional a ser usado na recuperação de tokens de acesso dos servidores de token do Google.

Retorna:

Credential

Uma credencial autenticada pela conta de serviço fornecida que pode ser usada para inicializar um app.

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

Exemplo 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(app)

Renderiza esse App inutilizável e libera os recursos de todos os serviços associados, embora *não* limpe nenhum recurso de back-end. Ao executar o SDK localmente, esse método precisa ser chamado para garantir o encerramento sem dificuldades do processo.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
app App

Retorna:

Promessa<void>

Exemplo

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

getApp(nomedoapp)

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
appName string

Retorna:

App

getApps()

Assinatura:

export declare function getApps(): App[];

Retorna:

App[]

inicializeApp(options, appName)

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
options AppOptions (em inglês)
appName string

Retorna:

App

updateToken(refreshTokenPathOrObject, httpAgent)

Retorna uma credencial criada a partir do token de atualização fornecido que concede acesso de administrador aos serviços do Firebase. Essa credencial pode ser usada na chamada para InitializeApp().

Consulte Inicializar o SDK para mais detalhes.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
updateTokenPathOrObject string | objeto O caminho para um arquivo JSON do token de atualização do Google OAuth2 ou um objeto que representa um token de atualização do Google OAuth2.
Agente HTTP Agente Agente HTTP opcional a ser usado na recuperação de tokens de acesso dos servidores de token do Google.

Retorna:

Credential

Uma credencial autenticada pela conta de serviço fornecida que pode ser usada para inicializar um app.

Exemplo

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

Versão do SDK

Assinatura:

SDK_VERSION: string