Esta página foi traduzida pela API Cloud Translation.

app package

Aplicativo do Firebase

Esse pacote coordena a comunicação entre os diferentes componentes do Firebase.

Funções

Função	Descrição
function(app, ...) (link em inglês)
deleteApp(app) (link em inglês)	torna o app inutilizável e libera os recursos de todos os serviços associados;
function().
getApps().	Uma matriz (somente leitura) de todos os aplicativos inicializados.
inicializarApp()	Cria e inicializa uma instância FirebaseApp.
function(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, version, variante)	Registra o nome e a versão de uma biblioteca para fins de geração de registros na plataforma.
function(logCallback, ...)
onLog(logCallback, options)	Define o gerenciador de registros para todos os SDKs do Firebase.
function(logLevel, ...)
setLogLevel(logLevel) (link em inglês)	Define o nível de registro para todos os SDKs do Firebase.Todos os tipos de registro acima do nível atual são capturados. Por exemplo, se você definir o nível de registro como `info`, os erros serão registrados, mas os registros `debug` e `verbose` não.
function(name, ...)
getApp(name) (em inglês)	Recupera uma instância do FirebaseApp.Quando chamado sem argumentos, o aplicativo padrão é retornado. Quando um nome de app é fornecido, o app correspondente a esse nome é retornado.Uma exceção é gerada se o app recuperado ainda não tiver sido inicializado.
function(options, ...)
inicializarApp(opções, nome)	Cria e inicializa uma instância FirebaseApp.Consulte a documentação detalhada em Adicionar o Firebase ao seu app e Inicializar vários projetos.
inicializarApp(opções, configuração)	Cria e inicializa uma instância FirebaseApp.
inicializarServerApp(opções, configuração)	Cria e inicializa uma instância FirebaseServerApp.O `FirebaseServerApp` é semelhante ao `FirebaseApp`, mas destina-se apenas à execução em ambientes de renderização do lado do servidor. A inicialização falhará se invocada de um ambiente de navegador.Consulte Adicionar o Firebase ao seu app e Inicializar vários projetos para ver a documentação detalhada.

Interfaces

Interface	Descrição
FirebaseApp	Um FirebaseApp contém as informações de inicialização para uma coleção de serviços.Não chame esse construtor diretamente. Em vez disso, use InitializeApp() para criar um aplicativo.
FirebaseAppSettings	Opções de configuração dadas para InitializeApp()
FirebaseOptions	do Firebase. Contém um conjunto de parâmetros exigidos pelos serviços para se comunicar com as APIs do servidor do Firebase e associar os dados do cliente ao seu projeto e aplicativo do Firebase. Normalmente, esse objeto é preenchido pelo Console do Firebase na configuração do projeto. Consulte também: Saiba mais sobre o objeto de configuração do Firebase.
FirebaseServerApp (em inglês)	Um FirebaseServerApp contém as informações de inicialização para uma coleção de serviços em execução em ambientes de servidor.Não chame esse construtor diretamente. Em vez disso, use InitializeServerApp() para criar um aplicativo.
FirebaseServerAppSettings (em inglês)	Opções de configuração dadas para InitializeServerApp()

Variáveis

Variável	Descrição
SDK_VERSION (em inglês)	A versão atual do SDK.

função(app, ...)

deleteApp(app)

torna o app inutilizável e libera os recursos de todos os serviços associados;

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
app	FirebaseApp

Retorna:

Promessa<void>

Exemplo

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

função()

getApps()

Uma matriz (somente leitura) de todos os aplicativos inicializados.

Assinatura:

export declare function getApps(): FirebaseApp[];

Retorna:

AppFirebase[]

inicializarApp()

Cria e inicializa uma instância FirebaseApp.

Assinatura:

export declare function initializeApp(): FirebaseApp;

Retorna:

FirebaseApp

function(libraryKeyOrName, ...)

registrarVersion(libraryKeyOrName, versão, variante)

Registra o nome e a versão de uma biblioteca para fins de geração de registros na plataforma.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
ChaveChaveOuNome	string
version	string	Versão atual dessa biblioteca.
variant	string	Variante do pacote, por exemplo, nó, rn etc.

Retorna:

void

function(logCallback, ...)

onLog(logCallback, opções)

Define o gerenciador de registros para todos os SDKs do Firebase.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
logCallback	LogCallback \| nulo	Um gerenciador de registros personalizado opcional que executa o código do usuário sempre que o SDK do Firebase faz uma chamada de geração de registros.
options	Opções de registro

Retorna:

void

function(logLevel, ...)

setLogLevel(logLevel)

Define o nível de registro de todos os SDKs do Firebase.

Todos os tipos de registro acima do nível atual são capturados. Ou seja, se você definir o nível de registro como info, os erros serão registrados, mas os registros debug e verbose não.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
logLevel	LogLevelString

Retorna:

void

função(nome, ...)

getApp(nome)

Recupera uma instância FirebaseApp.

Quando chamado sem argumentos, o app padrão é retornado. Quando um nome de app é fornecido, o app correspondente a esse nome é retornado.

Uma exceção será gerada se o app recuperado ainda não tiver sido inicializado.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
name	string	Nome opcional do app a ser retornado. Se nenhum nome for fornecido, o padrão será `"[DEFAULT]"`.

Retorna:

FirebaseApp

O app correspondente ao nome informado. Se nenhum nome de app for fornecido, o app padrão vai ser retornado.

Exemplo 1

// Return the default app
const app = getApp();

Exemplo 2

// Return a named app
const otherApp = getApp("otherApp");

função(options, ...)

inicializeApp(opções, nome)

Cria e inicializa uma instância FirebaseApp.

Consulte Adicionar o Firebase ao seu app e Inicializar vários projetos para conferir a documentação detalhada.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
options	FirebaseOptions	Opções para configurar os serviços do app.
nome	string	Nome opcional do app a ser inicializado. Se nenhum nome for fornecido, o padrão será `"[DEFAULT]"`.

Retorna:

FirebaseApp

O app inicializado.

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

Exemplo 2


// Initialize another app
const otherApp = initializeApp({
  databaseURL: "https://<OTHER_DATABASE_NAME>.firebaseio.com",
  storageBucket: "<OTHER_STORAGE_BUCKET>.appspot.com"
}, "otherApp");

inicializarApp(options, config)

Cria e inicializa uma instância FirebaseApp.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
options	FirebaseOptions	Opções para configurar os serviços do app.
config	FirebaseAppSettings	Configuração do FirebaseApp

Retorna:

FirebaseApp

inicializarServerApp(opções, configuração)

Cria e inicializa uma instância FirebaseServerApp.

O FirebaseServerApp é semelhante ao FirebaseApp, mas é destinado apenas à execução em ambientes de renderização do lado do servidor. A inicialização falhará se invocada de um ambiente de navegador.

Consulte Adicionar o Firebase ao seu app e Inicializar vários projetos para conferir a documentação detalhada.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
options	FirebaseOptions \| AppFirebase	`Firebase.AppOptions` para configurar os serviços do app, ou uma instância `FirebaseApp` que contenha o `AppOptions`.
config	FirebaseServerAppSettings (em inglês)	`FirebaseServerApp`.

Retorna:

FirebaseServerApp (em inglês)

O FirebaseServerApp inicializado.

Exemplo


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

Versão do SDK

A versão atual do SDK.

Assinatura:

SDK_VERSION: string