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;