auth namespace

功能

功能描述
用户(用户选项)处理与 Firebase Auth 用户事件相关的事件。
用户记录构造函数(wireData)根据通过线路发送的数据创建UserRecord类的帮助程序函数。

课程

班级描述
Https错误可以从处理程序引发的显式错误,以将错误发送到调用该函数的客户端。
用户生成器用于为 Firebase Auth 用户生命周期事件创建函数的构建器。
用户记录元数据用于在UserRecord对象中创建用户元数据的 Helper 类。

接口

界面描述
用户选项Auth 阻止功能选项。

类型别名

类型别名描述
用户信息UserInfoUserRecord的一部分。
用户记录传递到 Cloud Functions 的UserRecord与 Firebase Admin SDK 返回的UserRecord相同。

auth.user()

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

签名:

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

参数

范围类型描述
用户选项用户选项资源级别选项

返回:

用户生成器

UserBuilder - 用于为 Firebase Auth 用户生命周期事件创建函数的构建器

auth.userRecordConstructor()

根据通过线路发送的数据创建UserRecord类的帮助程序函数。

签名:

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

参数

范围类型描述
有线数据记录<字符串,未知>通过线路发送的数据

返回:

用户记录

具有正确 toJSON 函数的UserRecord实例

授权用户信息

UserInfoUserRecord的一部分

签名:

export type UserInfo = auth.UserInfo;

auth.UserRecord

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

签名:

export type UserRecord = auth.UserRecord;