app package

Firebase 应用

此软件包会协调不同 Firebase 组件之间的通信

函数

函数 说明
function(应用, ...)
deleteApp(app) 使此应用无法使用，并释放所有关联服务的资源。
函数
getApps() 包含所有已初始化应用的（只读）数组。
initializeApp() 创建并初始化 FirebaseApp 实例。
function(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, version, variant) 注册库的名称和版本，以进行平台日志记录。
function(logCallback, ...)
onLog(logCallback, options) 为所有 Firebase SDK 设置日志处理程序。
function(logLevel, ...)
setLogLevel(logLevel) 为所有 Firebase SDK 设置日志级别。系统会捕获当前日志级别之上的所有日志类型（也就是说，如果您将日志级别设置为 info，系统会记录错误，但不会记录 debug 和 verbose 日志）。
函数(name, ...)
getApp(name) 检索 FirebaseApp 实例。如果在不带参数的情况下调用，则返回默认应用。如果提供了应用名称，系统会返回与该名称对应的应用。如果要检索的应用尚未初始化，系统会抛出异常。
function(options, ...)
initializeApp(options, name) 创建并初始化一个 FirebaseApp 实例。如需查看详细文档，请参阅将 Firebase 添加到您的应用和初始化多个项目。
initializeApp(options, config) 创建并初始化 FirebaseApp 实例。
initializeServerApp(options, config) 创建并初始化 FirebaseServerApp 实例。FirebaseServerApp 与 FirebaseApp 类似，但仅适用于服务器端渲染环境。如果在浏览器环境中调用，初始化将失败。如需查看详细文档，请参阅将 Firebase 添加到您的应用和初始化多个项目。

接口

接口 说明
FirebaseApp FirebaseApp 保存一组服务的初始化信息。请勿直接调用此构造函数，请改为使用 initializeApp() 创建应用。
FirebaseAppSettings 为 initializeApp() 提供的配置选项
FirebaseOptions Firebase 配置对象。包含服务为了成功与 Firebase 服务器 API 通信以及将客户端数据与您的 Firebase 项目和 Firebase 应用关联所需的一组参数。通常，此对象在项目设置时由 Firebase 控制台填充。另请参阅：了解 Firebase 配置对象。
FirebaseServerApp FirebaseServerApp 保存在服务器环境中运行的一组服务的初始化信息。请勿直接调用此构造函数，请改为使用 initializeServerApp() 创建应用。
FirebaseServerAppSettings 为 initializeServerApp() 提供的配置选项

变量

变量 说明
SDK_VERSION 当前的 SDK 版本。

function(应用, ...)

deleteApp(应用)

使此应用无法使用，并释放所有关联服务的资源。

签名：

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

参数

参数 类型 说明
应用 FirebaseApp

返回：

承诺<void>

示例

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

function()

getApps()

包含所有已初始化应用的（只读）数组。

签名：

export declare function getApps(): FirebaseApp[];

返回：

FirebaseApp[]

initializeApp()

创建并初始化 FirebaseApp 实例。

签名：

export declare function initializeApp(): FirebaseApp;

返回：

FirebaseApp

function(libraryKeyOrName, ...)

enrollVersion(libraryKeyOrName, version, variant)

注册库的名称和版本，以进行平台日志记录。

签名：

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

参数

参数 类型 说明
libraryKeyOrName 字符串
版本 字符串 该库的当前版本。
variant 字符串 Bundle 变体，例如 node、rn 等。

返回：

void

function(logCallback, ...)

onLog(logCallback, options)

为所有 Firebase SDK 设置日志处理程序。

签名：

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

参数

参数 类型 说明
logCallback LogCallback |null 一个可选的自定义日志处理程序，可在 Firebase SDK 进行日志记录调用时执行用户代码。
选项 日志选项

返回：

void

function(logLevel, ...)

setLogLevel(logLevel)

设置所有 Firebase SDK 的日志级别。

系统会捕获当前日志级别以上的所有日志类型（也就是说，如果您将日志级别设置为 info，系统会记录错误，但不会记录 debug 和 verbose 日志）。

签名：

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

参数

参数 类型 说明
logLevel LogLevelString

返回：

void

function(name, ...)

getApp(名称)

检索 FirebaseApp 实例。

如果不使用任何参数进行调用，则返回默认应用。如果提供了应用名称，则返回与该名称对应的应用。

如果要检索的应用尚未初始化，则会抛出异常。

签名：

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

参数

参数 类型 说明
name 字符串 要返回的应用的可选名称。如果未提供名称，则默认为 "[DEFAULT]"。

返回：

FirebaseApp

与提供的应用名称对应的应用。如果未提供应用名称，则返回默认应用。

示例 1

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

示例 2

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

function(options, ...)

initializeApp(options, name)

创建并初始化一个 FirebaseApp 实例。

如需查看详细文档，请参阅将 Firebase 添加到您的应用和初始化多个项目。

签名：

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

参数

参数 类型 说明
选项 FirebaseOptions 用于配置应用服务的选项。
名称 字符串 要初始化的应用的可选名称。如果未提供名称，则默认为 "[DEFAULT]"。

返回：

FirebaseApp

初始化的应用。

示例 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
});

示例 2


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

initializeApp(options, config)

创建并初始化 FirebaseApp 实例。

签名：

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

参数

参数 类型 说明
选项 FirebaseOptions 用于配置应用服务的选项。
config FirebaseAppSettings FirebaseApp 配置

返回：

FirebaseApp

initializeServerApp(options, config)

创建并初始化一个 FirebaseServerApp 实例。

FirebaseServerApp 与 FirebaseApp 类似，但仅适用于服务器端渲染环境。如果从浏览器环境中调用，初始化将失败。

如需查看详细文档，请参阅将 Firebase 添加到您的应用和初始化多个项目。

签名：

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

参数

参数 类型 说明
选项 FirebaseOptions |FirebaseApp Firebase.AppOptions（用于配置应用的服务），或包含 AppOptions 的 FirebaseApp 实例。
config FirebaseServerAppSettings FirebaseServerApp 配置。

返回：

FirebaseServerApp

初始化的 FirebaseServerApp。

示例


// 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

当前的 SDK 版本。

签名：

SDK_VERSION: string