関数を呼び出したクライアントにエラーを送信するためにハンドラーからスローされる明示的なエラー。
サイン:
export declare class HttpsError extends Error
拡張:エラー
コンストラクター
コンストラクタ | 修飾子 | 説明 |
---|---|---|
(コンストラクター)(コード、メッセージ、詳細) | HttpsError クラスの新しいインスタンスを構築します |
プロパティ
財産 | 修飾子 | タイプ | 説明 |
---|---|---|---|
コード | 関数エラーコード | クライアントに返される標準エラー コード。これにより、code.proto で定義されている応答の HTTP ステータス コードも決まります。 | |
詳細 | 未知 | JSON に変換され、エラー応答に含まれる追加データ。 | |
httpエラーコード | HTTPエラーコード | 提供されたエラー コードのワイヤ形式表現。 |
メソッド
方法 | 修飾子 | 説明 |
---|---|---|
toJSON() | このオブジェクトの JSON シリアル化可能な表現を返します。 |
identity.HttpsError.(コンストラクター)
HttpsError
クラスの新しいインスタンスを構築します
サイン:
constructor(code: FunctionsErrorCode, message: string, details?: unknown);
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
コード | 関数エラーコード | |
メッセージ | 弦 | |
詳細 | 未知 |
identity.HttpsError.code
クライアントに返される標準エラー コード。これにより、code.proto で定義されている応答の HTTP ステータス コードも決まります。
サイン:
readonly code: FunctionsErrorCode;
アイデンティティ.HttpsError.details
JSON に変換され、エラー応答に含まれる追加データ。
サイン:
readonly details: unknown;
identity.HttpsError.httpErrorCode
提供されたエラー コードのワイヤ形式表現。
サイン:
readonly httpErrorCode: HttpErrorCode;
identity.HttpsError.toJSON()
このオブジェクトの JSON シリアル化可能な表現を返します。
サイン:
toJSON(): HttpErrorWireFormat;
戻り値:
HttpErrorWireFormat