Firebase 应用程序
该包协调不同 Firebase 组件之间的通信
功能
功能 | 描述 |
---|---|
函数(应用程序,...) | |
删除应用程序(应用程序) | 使该应用程序无法使用并释放所有关联服务的资源。 |
功能() | |
获取应用程序() | 所有已初始化应用程序的(只读)数组。 |
初始化应用程序() | 创建并初始化 FirebaseApp 实例。 |
函数(库键或名称,...) | |
registerVersion(libraryKeyOrName, 版本, 变体) | 注册库的名称和版本以用于平台日志记录。 |
函数(logCallback,...) | |
onLog(logCallback, 选项) | 为所有 Firebase SDK 设置日志处理程序。 |
函数(日志级别,...) | |
设置日志级别(日志级别) | 设置所有 Firebase SDK 的日志级别。所有高于当前日志级别的日志类型都会被捕获(即,如果将日志级别设置为info ,则会记录错误,但不会debug 和verbose 日志)。 |
函数(名称,...) | |
获取应用程序(名称) | 检索FirebaseApp实例。当不带参数调用时,将返回默认应用程序。当提供应用程序名称时,将返回与该名称对应的应用程序。如果正在检索的应用程序尚未初始化,则会引发异常。 |
功能(选项,...) | |
初始化应用程序(选项,名称) | 创建并初始化FirebaseApp实例。请参阅将 Firebase 添加到您的应用和初始化多个项目以获取详细文档。 |
初始化应用程序(选项,配置) | 创建并初始化 FirebaseApp 实例。 |
接口
界面 | 描述 |
---|---|
Firebase应用程序 | FirebaseApp保存一组服务的初始化信息。不要直接调用此构造函数。相反,使用initializeApp()来创建应用程序。 |
Firebase应用程序设置 | 为initializeApp()提供的配置选项 |
Firebase选项 | Firebase 配置对象。包含服务所需的一组参数,以便成功与 Firebase 服务器 API 通信并将客户端数据与您的 Firebase 项目和 Firebase 应用程序关联。通常,此对象由 Firebase 控制台在项目设置时填充。另请参阅:了解 Firebase 配置对象。 |
变量
多变的 | 描述 |
---|---|
SDK_VERSION | 当前的 SDK 版本。 |
函数(应用程序,...)
删除应用程序(应用程序)
使该应用程序无法使用并释放所有关联服务的资源。
签名:
export declare function deleteApp(app: FirebaseApp): Promise<void>;
参数
范围 | 类型 | 描述 |
---|---|---|
应用程序 | Firebase应用程序 |
返回:
承诺<无效>
例子
deleteApp(app)
.then(function() {
console.log("App deleted successfully");
})
.catch(function(error) {
console.log("Error deleting app:", error);
});
功能()
获取应用程序()
所有已初始化应用程序的(只读)数组。
签名:
export declare function getApps(): FirebaseApp[];
返回:
初始化应用程序()
创建并初始化 FirebaseApp 实例。
签名:
export declare function initializeApp(): FirebaseApp;
返回:
函数(库键或名称,...)
registerVersion(libraryKeyOrName, 版本, 变体)
注册库的名称和版本以用于平台日志记录。
签名:
export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
参数
范围 | 类型 | 描述 |
---|---|---|
库键或名称 | 细绳 | |
版本 | 细绳 | 该库的当前版本。 |
变体 | 细绳 | 捆绑变体,例如,node、rn 等。 |
返回:
空白
函数(logCallback,...)
onLog(logCallback, 选项)
为所有 Firebase SDK 设置日志处理程序。
签名:
export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
参数
范围 | 类型 | 描述 |
---|---|---|
日志回调 | 日志回调 |无效的 | 可选的自定义日志处理程序,每当 Firebase SDK 进行日志记录调用时,该处理程序都会执行用户代码。 |
选项 | 日志选项 |
返回:
空白
函数(日志级别,...)
设置日志级别(日志级别)
设置所有 Firebase SDK 的日志级别。
捕获当前日志级别以上的所有日志类型(即,如果将日志级别设置为info
,会记录错误,但不会记录debug
和verbose
日志)。
签名:
export declare function setLogLevel(logLevel: LogLevelString): void;
参数
范围 | 类型 | 描述 |
---|---|---|
日志级别 | 日志级别字符串 |
返回:
空白
函数(名称,...)
获取应用程序(名称)
检索FirebaseApp实例。
当不带参数调用时,将返回默认应用程序。当提供应用程序名称时,将返回与该名称对应的应用程序。
如果正在检索的应用程序尚未初始化,则会引发异常。
签名:
export declare function getApp(name?: string): FirebaseApp;
参数
范围 | 类型 | 描述 |
---|---|---|
姓名 | 细绳 | 要返回的应用程序的可选名称。如果未提供名称,则默认为"[DEFAULT]" 。 |
返回:
与提供的应用程序名称对应的应用程序。如果未提供应用程序名称,则返回默认应用程序。
实施例1
// Return the default app
const app = getApp();
实施例2
// Return a named app
const otherApp = getApp("otherApp");
功能(选项,...)
初始化应用程序(选项,名称)
创建并初始化FirebaseApp实例。
请参阅将 Firebase 添加到您的应用和初始化多个项目以获取详细文档。
签名:
export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
参数
范围 | 类型 | 描述 |
---|---|---|
选项 | Firebase选项 | 配置应用程序服务的选项。 |
姓名 | 细绳 | 要初始化的应用程序的可选名称。如果未提供名称,则默认为"[DEFAULT]" 。 |
返回:
初始化的应用程序。
实施例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");
初始化应用程序(选项,配置)
创建并初始化 FirebaseApp 实例。
签名:
export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
参数
范围 | 类型 | 描述 |
---|---|---|
选项 | Firebase选项 | 配置应用程序服务的选项。 |
配置 | Firebase应用程序设置 | Firebase应用程序配置 |
返回:
SDK_VERSION
当前的 SDK 版本。
签名:
SDK_VERSION: string