firebase-admin.app package

Inicialização do aplicativo Firebase e SDK.

Funções

Função Descrição
applicationDefault(httpAgente) Retorna uma credencial criada a partir das credenciais padrão do aplicativo Google que concede acesso de administrador aos serviços do Firebase. Esta credencial pode ser usada na chamada para inicializarApp() . As credenciais padrão do aplicativo Google estão disponíveis em qualquer infraestrutura do Google, como Google App Engine e Google Compute Engine. Consulte Inicializar o SDK para obter mais detalhes.
certificado(serviceAccountPathOrObject, httpAgent) Retorna uma credencial criada a partir da conta de serviço fornecida que concede acesso de administrador aos serviços do Firebase. Esta credencial pode ser usada na chamada para inicializarApp() . Consulte Inicializar o SDK para obter mais detalhes.
excluirAplicativo(aplicativo) Torna este 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 deve ser chamado para garantir o encerramento normal do processo.
getApp(nomedoaplicativo)
getApps()
inicializarApp(opções, appName)
atualizarToken(refreshTokenPathOrObject, httpAgent) Retorna uma credencial criada a partir do token de atualização fornecido que concede acesso de administrador aos serviços do Firebase. Esta credencial pode ser usada na chamada para inicializarApp() . Consulte Inicializar o SDK para obter mais detalhes.

Interfaces

Interface Descrição
Aplicativo Um aplicativo Firebase contém as informações de inicialização de um conjunto de serviços.
Opções de aplicativos Opções disponíveis para passar para inicializarApp() .
Credencial Interface que fornece tokens de acesso Google OAuth2 usados ​​para autenticação com serviços do Firebase. Na maioria dos casos, você não precisará implementar isso sozinho e poderá 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 obter o item com erro.
Erro Firebase FirebaseError é uma subclasse do objeto JavaScript Error padrão. Além de uma sequência de mensagens e rastreamento de pilha, ele contém um código de sequência.
GoogleOAuthAccessToken Interface para tokens de acesso Google OAuth 2.0.
Conta de serviço

Variáveis

Variável Descrição
SDK_VERSION

aplicaçãoDefault()

Retorna uma credencial criada a partir das credenciais padrão do aplicativo Google que concede acesso de administrador aos serviços do Firebase. Esta credencial pode ser usada na chamada para inicializarApp() .

As credenciais padrão do aplicativo Google estão disponíveis em qualquer infraestrutura do Google, como Google App Engine e Google Compute Engine.

Consulte Inicializar o SDK para obter mais detalhes.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
httpAgente Agente Agente HTTP opcional a ser usado ao recuperar tokens de acesso de servidores de token do Google.

Retorna:

Credencial

Uma credencial autenticada por meio do Google Application Default Credentials que pode ser usada para inicializar um aplicativo.

Exemplo

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

certificado()

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

Consulte Inicializar o SDK para obter mais detalhes.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
serviceAccountPathOrObject corda | Conta de serviço 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.
httpAgente Agente Agente HTTP opcional a ser usado ao recuperar tokens de acesso de servidores de token do Google.

Retorna:

Credencial

Uma credencial autenticada por meio da conta de serviço fornecida que pode ser usada para inicializar um aplicativo.

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

deletarApp()

Torna este 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 deve ser chamado para garantir o encerramento normal do processo.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo

Retorna:

Promessa<void>

Exemplo

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

adquirir aplicativo()

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
nome do aplicativo corda

Retorna:

Aplicativo

getApps()

Assinatura:

export declare function getApps(): App[];

Retorna:

Aplicativo []

inicializarApp()

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
opções Opções de aplicativos
nome do aplicativo corda

Retorna:

Aplicativo

atualizarToken()

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

Consulte Inicializar o SDK para obter mais detalhes.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
atualizarTokenPathOrObject corda | 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.
httpAgente Agente Agente HTTP opcional a ser usado ao recuperar tokens de acesso de servidores de token do Google.

Retorna:

Credencial

Uma credencial autenticada por meio da conta de serviço fornecida que pode ser usada para inicializar um aplicativo.

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

SDK_VERSION

Assinatura:

SDK_VERSION: string