auth namespace

Fungsi

Fungsi Keterangan
pengguna(Opsi pengguna) Menangani peristiwa yang terkait dengan peristiwa pengguna Firebase Auth.
penggunaRecordConstructor(wireData) Fungsi pembantu yang membuat kelas UserRecord dari data yang dikirim melalui kabel.

Kelas

Kelas Keterangan
HttpsError Kesalahan eksplisit yang dapat dilempar dari penangan untuk mengirim kesalahan ke klien yang memanggil fungsi tersebut.
Pembuat Pengguna Builder digunakan untuk membuat fungsi untuk peristiwa siklus hidup pengguna Firebase Auth.
Metadata Catatan Pengguna Kelas pembantu untuk membuat metadata pengguna di objek UserRecord .

Antarmuka

Antarmuka Keterangan
Opsi Pengguna Opsi untuk fungsi pemblokiran Auth.

Ketik Alias

Ketik Alias Keterangan
Info Pengguna UserInfo yang merupakan bagian dari UserRecord .
Catatan Pengguna UserRecord yang diteruskan ke Cloud Functions adalah UserRecord yang sama yang dikembalikan oleh Firebase Admin SDK.

auth.pengguna()

Menangani peristiwa yang terkait dengan peristiwa pengguna Firebase Auth.

Tanda tangan:

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

Parameter

Parameter Jenis Keterangan
opsi pengguna Opsi Pengguna Opsi tingkat sumber daya

Pengembalian:

Pembuat Pengguna

UserBuilder - Builder yang digunakan untuk membuat fungsi untuk peristiwa siklus hidup pengguna Firebase Auth

auth.userRecordConstructor()

Fungsi pembantu yang membuat kelas UserRecord dari data yang dikirim melalui kabel.

Tanda tangan:

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

Parameter

Parameter Jenis Keterangan
kawatData Rekam<string, tidak diketahui> data yang dikirim melalui kabel

Pengembalian:

Catatan Pengguna

sebuah instance dari UserRecord dengan fungsi toJSON yang benar

auth.UserInfo

UserInfo yang merupakan bagian dari UserRecord .

Tanda tangan:

export type UserInfo = auth.UserInfo;

auth.UserRecord

UserRecord yang diteruskan ke Cloud Functions adalah UserRecord yang sama yang dikembalikan oleh Firebase Admin SDK.

Tanda tangan:

export type UserRecord = auth.UserRecord;