app package

Aplicativo do Firebase

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

Funções

Função Descrição
função(app, ...)
deleteApp(app) (link em inglês) Torna o aplicativo inutilizável e libera os recursos de todos os serviços associados.
função()
getApps() Uma matriz (somente leitura) de todos os aplicativos inicializados.
initializeApp() Cria e inicializa uma instância de FirebaseApp.
function(libraryKeyOrName, ...).
registerVersion(libraryKeyOrName, version, variant) Registra o nome e a versão de uma biblioteca para fins de registro da plataforma.
Função(logCallback, ...)
onLog(logCallback, options) Define o gerenciador de registros para todos os SDKs do Firebase.
função(logLevel, ...)
setLogLevel(logLevel) 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 (ou seja, se você definir o nível de registro como info, serão registrados erros, mas os registros debug e verbose não serão).
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.Se o app que está sendo recuperado ainda não tiver sido inicializado, uma exceção será gerada.
função(opções, ...)
InitializeApp(options, name) Cria e inicializa uma instância FirebaseApp.Consulte Adicionar o Firebase ao seu app e Inicializar vários projetos para ver a documentação detalhada.
InitializeApp(options, config) Cria e inicializa uma instância de FirebaseApp.
InitializeServerApp(options, config) Cria e inicializa uma instância FirebaseServerApp.O FirebaseServerApp é semelhante a FirebaseApp, mas destina-se a execução apenas 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 de 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 Objeto de configuração 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 dados do cliente ao projeto e ao 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 Um FirebaseServerApp contém as informações de inicialização para um conjunto de serviços executados em ambientes de servidor.Não chame esse construtor diretamente. Em vez disso, use InitializeServerApp() para criar um aplicativo.
FirebaseServerAppSettings Opções de configuração dadas para InitializeServerApp()

Variáveis

Variável Descrição
SDK_VERSION A versão atual do SDK.

função(app; ...)

deleteApp(app)

Torna o aplicativo inutilizável e libera os recursos de todos os serviços associados.

Signature:

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

Parâmetros

Parâmetro Tipo Descrição
app FirebaseApp

Retorna:

Promise<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.

Signature:

export declare function getApps(): FirebaseApp[];

Retorna:

FirebaseApp[]

initializeApp()

Cria e inicializa uma instância de FirebaseApp.

Signature:

export declare function initializeApp(): FirebaseApp;

Retorna:

FirebaseApp

função(libraryKeyOrName, ...)

registerVersion(libraryKeyOrName, version, variant)

Registra o nome e a versão de uma biblioteca para fins de registro da plataforma.

Signature:

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

Parâmetros

Parâmetro Tipo Descrição
libraryKeyOrName string
versão string Versão atual dessa biblioteca.
variant string Variante do pacote, como nó, rn etc.

Retorna:

void

função(logCallback, ...)

onLog(logCallback, opções)

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

Signature:

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.
do modelo. LogOptions

Retorna:

void

função(logLevel, ...)

setLogLevel(logLevel)

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

Todos os tipos de registro acima do nível de registro 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 serão).

Signature:

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 aplicativo é fornecido, o aplicativo correspondente a esse nome é retornado.

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

Signature:

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 de app fornecido. Se nenhum nome de aplicativo for fornecido, o aplicativo padrão será retornado.

Exemplo 1

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

Exemplo 2

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

função(opções, ...)

startupApp(options, nome)

Cria e inicializa uma instância FirebaseApp.

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

Signature:

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

Parâmetros

Parâmetro Tipo Descrição
do modelo. FirebaseOptions Opções para configurar os serviços do app.
name 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");

launchApp(options, config)

Cria e inicializa uma instância de FirebaseApp.

Signature:

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

Parâmetros

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

Retorna:

FirebaseApp

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

Cria e inicializa uma instância FirebaseServerApp.

O FirebaseServerApp é semelhante ao FirebaseApp, mas precisa ser executado apenas 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 app e Inicializar vários projetos para conferir a documentação detalhada.

Signature:

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

Parâmetros

Parâmetro Tipo Descrição
do modelo. FirebaseOptions | FirebaseApp Firebase.AppOptions para configurar os serviços do app ou uma instância FirebaseApp que contenha o AppOptions.
config FirebaseServerAppSettings FirebaseServerApp.

Retorna:

FirebaseServerApp

A FirebaseServerApp inicializada.

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

SDK_VERSION

A versão atual do SDK.

Signature:

SDK_VERSION: string