FirebaseServerAppSettings interface

initializeServerApp() 提供的配置选项

签名

export interface FirebaseServerAppSettings extends Omit<FirebaseAppSettings, 'name'> 

扩展: Omit<FirebaseAppSettings, 'name'>

属性

属性 类型 说明
authIdToken string 一个可选的 Auth ID 令牌,用于从客户端运行时环境中恢复已登录的用户会话。使用配置了经过验证的 authIdTokenFirebaseServerApp 调用 getAuth 时,系统会自动尝试登录 authIdToken 所代表的用户。此令牌必须是在最近刚创建的,此操作才能成功。如果令牌本地验证失败,或者初始化 Auth SDK 时 Auth 服务无法验证令牌,控制台就会发出警告,且 Auth SDK 不会在初始化时让用户登录。如果用户成功登录,系统就会按照标准 Auth 流程使用 User 对象调用 Auth 实例的 onAuthStateChanged 回调函数。不过,通过 authIdToken 创建的 User 对象没有刷新令牌。尝试执行的 refreshToken 操作失败。
releaseOnDeref 对象 可选对象。如果提供,Firebase SDK 会使用 FinalizationRegistry 对象来监控所提供对象的垃圾回收状态。当所提供的 releaseOnDeref 对象被垃圾回收时,Firebase SDK 会在 FirebaseServerApp 实例上释放其引用。您可以使用此字段减少应用的内存管理开销。如果提供该参数,则在 SSR 传递中运行的应用无需执行 FirebaseServerApp 清理,只要引用对象被删除(例如,因超出 SSR 范围而被删除)。如果未提供对象,则应用必须通过调用 deleteApp 来清理 FirebaseServerApp 实例。如果应用在此参数中提供了一个对象,但应用将在 JavaScript 引擎中执行,而 v4 会在实例 v4 支持之前抛出 FinalizationRegistry 错误。FirebaseServerApp

FirebaseServerAppSettings.authIdToken

可选的 Auth ID 令牌,用于从客户端运行时环境恢复已登录的用户会话。

如果使用配置了经过验证的 authIdTokenFirebaseServerApp 调用 getAuth,则系统会自动尝试让 authIdToken 代表的用户登录。此令牌必须是最近创建的,此操作才能成功。

如果该令牌未通过本地验证,或者初始化 Auth SDK 时 Auth 服务无法验证,那么控制台将记录一条警告,且 Auth SDK 不会在初始化时让用户登录。

如果用户成功登录,系统会按照标准 Auth 流程使用 User 对象调用 Auth 实例的 onAuthStateChanged 回调函数。不过,通过 authIdToken 创建的 User 对象没有刷新令牌。尝试执行的 refreshToken 操作失败。

签名

authIdToken?: string;

FirebaseServerAppSettings.releaseOnDeref

可选对象。如果提供,Firebase SDK 会使用 FinalizationRegistry 对象来监控所提供对象的垃圾回收状态。当提供的 releaseOnDeref 对象被垃圾回收时,Firebase SDK 会在 FirebaseServerApp 实例上释放其引用。

您可以使用此字段减少应用的内存管理开销。如果提供了此属性,只要引用对象被删除(例如,因超出 SSR 范围),在 SSR 传递中运行的应用就无需执行 FirebaseServerApp 清理。

如果未提供对象,则应用必须通过调用 deleteApp 来清理 FirebaseServerApp 实例。

如果应用在此参数中提供了一个对象,但应用是在支持 FinalizationRegistry(例如,在节点 v14.6.0 中引入)之前的 JavaScript 引擎中执行的,那么初始化 FirebaseServerApp 时会抛出错误。

签名

releaseOnDeref?: object;