auth namespace

関数

関数 説明
user(userOptions) Firebase Auth のユーザー イベントに関連するイベントを処理します。
userRecordConstructor(wireData) 有線で送信されたデータから UserRecord クラスを作成するヘルパー関数。

クラス

クラス 説明
HttpsError 関数を呼び出したクライアントにエラーを送信するためにハンドラからスローされる明示的なエラー。
UserBuilder Firebase Auth のユーザー ライフサイクル イベントの関数を作成するために使用されるビルダー。
UserRecordMetadata UserRecord オブジェクトにユーザー メタデータを作成するヘルパークラス。

インターフェース

インターフェース 説明
UserOptions Auth ブロック関数のオプション。

型エイリアス

型エイリアス 説明
UserInfo UserRecord の一部である UserInfo。
UserRecord Cloud Functions に渡される UserRecord は、Firebase Admin SDK によって返される UserRecord と同じです。

auth.user()

Firebase Auth ユーザー イベントに関連するイベントを処理します。

署名:

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

パラメータ

パラメータ 型 説明
userOptions UserOptions リソースレベルのオプション

戻り値:

UserBuilder

UserBuilder - Firebase Auth のユーザー ライフサイクル イベントの関数を作成するために使用されるビルダー

auth.userRecordConstructor()

有線で送信されたデータから UserRecord クラスを作成するヘルパー関数。

署名:

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

パラメータ

パラメータ 型 説明
wireData レコード <文字列、不明> ネットワークで送信される

戻り値:

UserRecord

正しい toJSON 関数を含む UserRecord のインスタンス

auth.UserInfo

UserRecord の一部である UserInfo。

署名:

export type UserInfo = auth.UserInfo;

auth.UserRecord

Cloud Functions に渡される UserRecord は、Firebase Admin SDK によって返される UserRecord と同じです。

署名:

export type UserRecord = auth.UserRecord;