FirebaseServerAppSettings interface

initializeServerApp() 提供的配置选项

Signature:

export interface FirebaseServerAppSettings extends FirebaseAppSettings 

扩展FirebaseAppSettings

属性

媒体资源 类型 说明
authIdToken string 可选的 Auth ID 令牌,用于从客户端运行时环境恢复已登录的用户会话。使用带有经过验证的 authIdToken 配置的 FirebaseServerApp 调用 getAuth 时,会导致系统自动尝试让 authIdToken 所代表的用户登录。此操作需要最近才创建,此操作才能成功。如果令牌未通过本地验证,或者 Auth 服务在初始化 Auth SDK 时未能对其进行验证,控制台会记录一条警告,并且 Auth SDK 不会在初始化时让用户登录。如果用户成功登录,则按照标准 Auth 流程,使用 User 对象调用 Auth 实例的 onAuthStateChanged 回调函数。但是,通过 authIdToken 创建的 User 对象没有刷新令牌。尝试的 refreshToken 操作失败。
name 未指定 FirebaseServerApp 没有 getApp() 操作,因此该名称与应用无关。不过,它可以在内部使用,并且在此处进行声明,以便 FirebaseServerApp 符合 FirebaseApp 接口的要求。
releaseOnDeref 对象 可选对象。如果提供,Firebase SDK 会使用 FinalizationRegistry 对象来监控所提供对象的垃圾回收状态。对提供的 releaseOnDeref 对象进行垃圾回收时,Firebase SDK 会在 FirebaseServerApp 实例上释放其引用。您可以使用此字段减少应用的内存管理开销。如果提供,在 SSR 传递中运行的应用无需执行 FirebaseServerApp 清理,只要引用对象被删除(例如,通过超出 SSR 范围即可)。如果未提供对象,应用必须通过调用 deleteApp 来清理 FirebaseServerApp 实例。如果应用在此参数中提供了一个对象,但应用是在 1 节点支持 FinalizationRegistry 之前抛出的 JavaScript 引擎(在 v1 中引入的 v0 之前会抛出 v0)。FirebaseServerApp

FirebaseServerAppSettings.authIdToken

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

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

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

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

Signature:

authIdToken?: string;

FirebaseServerAppSettings.name

FirebaseServerApp 没有 getApp() 操作,因此该名称与应用无关。不过,它可以在内部使用,并且在此处进行声明,以便 FirebaseServerApp 符合 FirebaseApp 接口的要求。

Signature:

name?: undefined;

FirebaseServerAppSettings.releaseOnDeref

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

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

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

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

Signature:

releaseOnDeref?: object;