app package

Firebase 应用

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

函数

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

接口

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

变量

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

function(app, ...)

deleteApp(应用)

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

Signature:

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

参数

参数 类型 说明
app FirebaseApp

返回

Promise<void>

示例

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

function()

getApps()

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

Signature:

export declare function getApps(): FirebaseApp[];

返回

FirebaseApp[]

initializeApp()

创建并初始化 FirebaseApp 实例。

Signature:

export declare function initializeApp(): FirebaseApp;

返回

FirebaseApp

function(libraryKeyOrName, ...)

registerVersion(libraryKeyOrName, version, variant)

注册用于平台日志记录的库名称和版本。

Signature:

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

参数

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

返回

void

function(logCallback, ...)

onLog(logCallback, 选项)

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

Signature:

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

参数

参数 类型 说明
logCallback LogCallback | null 可选的自定义日志处理程序,只要 Firebase SDK 进行日志记录调用,该日志处理程序就会执行用户代码。
选项 LogOptions

返回

void

function(logLevel, ...)

setLogLevel(logLevel)

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

系统会捕获高于当前日志级别的所有日志类型(也就是说,如果将日志级别设置为 info,系统会记录错误,但不会记录 debugverbose 日志)。

Signature:

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

参数

参数 类型 说明
logLevel LogLevelString

返回

void

function(name, ...)

getApp(名称)

检索 FirebaseApp 实例。

不使用参数进行调用时,将返回默认应用。提供应用名称后,系统会返回与该名称对应的应用。

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

Signature:

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

参数

参数 类型 说明
name string 要返回的应用的可选名称。如果未提供名称,则默认值为 "[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 添加到您的应用初始化多个项目

Signature:

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

参数

参数 类型 说明
选项 FirebaseOptions 用于配置应用服务的选项。
name string 要初始化的应用的可选名称。如果未提供名称,则默认值为 "[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 实例。

Signature:

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

参数

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

返回

FirebaseApp

initializeServerApp(options, config)

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

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

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

Signature:

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

参数

参数 类型 说明
选项 FirebaseOptions | FirebaseApp Firebase.AppOptions(用于配置应用的服务),或一个包含 AppOptionsFirebaseApp 实例。
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 版本。

Signature:

SDK_VERSION: string