auth namespace

函式

函式	說明
user(userOptions)	處理與 Firebase 驗證使用者事件相關的事件。
userRecordConstructor(wireData)	透過線路傳送的資料建立 UserRecord 類別的輔助函式。

類別

類別	說明
HttpsError	可從處理常式擲回的明確錯誤，將錯誤傳送至呼叫該函式的用戶端。
UserBuilder	用來建立 Firebase 驗證使用者生命週期事件函式的建構工具。
使用者記錄中繼資料	可在 UserRecord 物件中建立使用者中繼資料的輔助類別。

介面

介面	說明
UserOptions	驗證封鎖函式的選項。

型別別名

類型別名	說明
使用者資訊	UserInfo，即 UserRecord 的一部分。
使用者記錄	傳遞至 Cloud Functions 的 UserRecord 與 Firebase Admin SDK 傳回的 UserRecord 相同。

auth.user()

處理與 Firebase 驗證使用者事件相關的事件。

簽名：

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

參數

參數	類型	說明
使用者選項	UserOptions	資源層級選項

傳回：

UserBuilder

UserBuilder - 用來建立 Firebase 驗證使用者生命週期事件函式的建構工具

auth.userRecordConstructor()

透過線路傳送的資料建立 UserRecord 類別的輔助函式。

簽名：

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

參數

參數	類型	說明
有線資料	記錄<字串，未知>	資料通過線路

傳回：

使用者記錄

包含正確 toJSON 函式的 UserRecord 執行個體

驗證使用者資訊

UserInfo 為 UserRecord 中的一環。

簽名：

export type UserInfo = auth.UserInfo;

auth.UserRecord

傳遞至 Cloud Functions 的 UserRecord 與 Firebase Admin SDK 傳回的 UserRecord 相同。

簽名：

export type UserRecord = auth.UserRecord;