auth namespace

函数

函数	说明
user(userOptions)	处理与 Firebase Authentication 用户事件相关的事件。
userRecordConstructor(wireData)	辅助函数，用于根据通过网络发送的数据创建 UserRecord 类。

类

类	说明
HttpsError	可以从处理程序抛出的显式错误，以向调用函数的客户端发送错误。
UserBuilder	用于创建 Firebase Authentication 用户生命周期事件函数的构建器。
UserRecordMetadata	用于在 UserRecord 对象中创建用户元数据的辅助类。

接口

接口	说明
UserOptions	Auth 屏蔽函数选项。

类型别名

类型别名	说明
UserInfo	属于 UserRecord 的 UserInfo。
UserRecord	传递给 Cloud Functions 的 UserRecord 与 Firebase Admin SDK 返回的 UserRecord 相同。

使用 auth.user()

处理与 Firebase Authentication 用户事件相关的事件。

签名：

export declare function user(userOptions?: UserOptions): UserBuilder;

参数

参数	类型	说明
userOptions	UserOptions	资源层级选项

返回：

UserBuilder

UserBuilder - 用于创建 Firebase 身份验证用户生命周期事件函数的构建器

auth.userRecordConstructor()

辅助函数，用于根据通过网络发送的数据创建 UserRecord 类。

签名：

export declare function userRecordConstructor(wireData: Record<string, unknown>): UserRecord;

参数

参数	类型	说明
WireData	记录<字符串，未知>	通过网络发送的数据

返回：

UserRecord

具有正确的 toJSON 函数的 UserRecord 实例

auth.UserInfo

属于 UserRecord 的 UserInfo。

签名：

export type UserInfo = auth.UserInfo;

auth.UserRecord 身份验证

传递给 Cloud Functions 的 UserRecord 与 Firebase Admin SDK 返回的 UserRecord 相同。

签名：

export type UserRecord = auth.UserRecord;