auth.HttpsError class

関数を呼び出したクライアントにエラーを送信するためにハンドラからスローされる明示的なエラー。

署名:

export declare class HttpsError extends Error 

延長: エラー

コンストラクタ

コンストラクタ 修飾キー 説明
(コンストラクタ)(コード, メッセージ, 詳細) HttpsError クラスの新しいインスタンスを作成します。

プロパティ

プロパティ 修飾キー タイプ 説明
コード FunctionsErrorCode クライアントに返される標準のエラーコード。code.proto で定義されているレスポンスの HTTP ステータス コードもわかります。
詳細 不明 JSON に変換され、エラー レスポンスに含まれる追加データ。
httpErrorCode HTTPErrorCode 指定されたエラーコードの送信形式の表現。

メソッド

メソッド 修飾キー 説明
toJSON() このオブジェクトの JSON シリアル化可能な表現を返します。

auth.HttpsError.(コンストラクタ)

HttpsError クラスの新しいインスタンスを作成します。

署名:

constructor(code: FunctionsErrorCode, message: string, details?: unknown);

パラメータ

パラメータ 説明
コード FunctionsErrorCode
メッセージ 文字列
詳細 不明

auth.HttpsError.code

クライアントに返される標準のエラーコード。code.proto で定義されているレスポンスの HTTP ステータス コードもわかります。

署名:

readonly code: FunctionsErrorCode;

auth.HttpsError.details

JSON に変換され、エラー レスポンスに含まれる追加データ。

署名:

readonly details: unknown;

auth.HttpsError.httpErrorCode

指定されたエラーコードの送信形式の表現。

署名:

readonly httpErrorCode: HttpErrorCode;

auth.HttpsError.toJSON()

このオブジェクトの JSON シリアル化可能な表現を返します。

署名:

toJSON(): HttpErrorWireFormat;

戻り値:

HttpErrorWireFormat