auth namespace

Функции

Функция Описание
пользователь (опционы пользователя) Обрабатывает события, связанные с событиями пользователей Firebase Auth.
userRecordConstructor (wireData) Вспомогательная функция, которая создает класс UserRecord на основе данных, передаваемых по сети.

Классы

Сорт Описание
HttpsError Явная ошибка, которая может быть вызвана обработчиком для отправки ошибки клиенту, вызвавшему функцию.
Пользовательский конструктор Builder используется для создания функций для событий жизненного цикла пользователя Firebase Auth.
Усеррекордметаданные Вспомогательный класс для создания метаданных пользователя в объекте UserRecord .

Интерфейсы

Интерфейс Описание
Пользовательские параметры Варианты функции блокировки аутентификации.

Введите псевдонимы

Введите псевдоним Описание
Информация о пользователе UserInfo , являющийся частью UserRecord .
Пользовательская запись UserRecord передаваемый в Cloud Functions, — это тот же UserRecord , который возвращается Firebase Admin SDK.

авторизация.пользователь()

Обрабатывает события, связанные с событиями пользователей Firebase Auth.

Подпись:

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

Параметры

Параметр Тип Описание
Параметры пользователя Пользовательские параметры Параметры уровня ресурса

Возврат:

Пользовательский конструктор

UserBuilder — конструктор, используемый для создания функций для событий жизненного цикла пользователя Firebase Auth.

auth.userRecordConstructor()

Вспомогательная функция, которая создает класс UserRecord на основе данных, передаваемых по сети.

Подпись:

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

Параметры

Параметр Тип Описание
WireData Запись<строка, неизвестна> данные передаются по проводу

Возврат:

Пользовательская запись

экземпляр UserRecord с правильными функциями toJSON

авторизация.UserInfo

UserInfo , являющаяся частью UserRecord .

Подпись:

export type UserInfo = auth.UserInfo;

авторизация.UserRecord

UserRecord передаваемый в Cloud Functions, — это тот же UserRecord , который возвращается Firebase Admin SDK.

Подпись:

export type UserRecord = auth.UserRecord;