auth namespace

ฟังก์ชัน

ฟังก์ชัน	คำอธิบาย
user(userOptions)	จัดการเหตุการณ์ที่เกี่ยวข้องกับเหตุการณ์การตรวจสอบสิทธิ์ของผู้ใช้ Firebase
userRecordConstructor(wireData)	ฟังก์ชันตัวช่วยที่สร้างคลาส UserRecord จากข้อมูลที่ส่งผ่านสาย

ชั้นเรียน

ชั้น	คำอธิบาย
HttpsError	ข้อผิดพลาดที่ชัดเจนอาจเกิดจากตัวแฮนเดิลเพื่อส่งข้อผิดพลาดไปยังไคลเอ็นต์ที่เรียกใช้ฟังก์ชัน
UserBuilder	เครื่องมือสร้างที่ใช้เพื่อสร้างฟังก์ชันสำหรับเหตุการณ์ในวงจรของผู้ใช้การตรวจสอบสิทธิ์ Firebase
UserRecordMetadata	คลาส Helper เพื่อสร้างข้อมูลเมตาผู้ใช้ในออบเจ็กต์ UserRecord

อินเทอร์เฟซ

อินเทอร์เฟซ	คำอธิบาย
UserOptions	ตัวเลือกสำหรับฟังก์ชันการบล็อกการตรวจสอบสิทธิ์

พิมพ์ชื่อแทน

พิมพ์ชื่อแทน	คำอธิบาย
ข้อมูลผู้ใช้	UserInfo ซึ่งเป็นส่วนหนึ่งของ UserRecord
บันทึกผู้ใช้	UserRecord ที่ส่งไปยัง Cloud Functions คือ UserRecord เดียวกันกับที่ Firebase Admin SDK แสดงผล

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;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ข้อมูลสายไฟ	บันทึก<สตริง, ไม่ทราบ>	ข้อมูลที่ส่งผ่านสาย

การคืนสินค้า:

บันทึกผู้ใช้

อินสแตนซ์ของ UserRecord ที่มีฟังก์ชัน toJSON ที่ถูกต้อง

auth.UserInfo

UserInfo ซึ่งเป็นส่วนหนึ่งของ UserRecord

ลายเซ็น:

export type UserInfo = auth.UserInfo;

auth.UserRecord

UserRecord ที่ส่งไปยัง Cloud Functions คือ UserRecord เดียวกันกับที่ Firebase Admin SDK แสดงผล

ลายเซ็น:

export type UserRecord = auth.UserRecord;