https.HttpsError class

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

サイン:

export declare class HttpsError extends Error 

拡張:エラー

コンストラクター

コンストラクタ修飾子説明
(コンストラクター)(コード、メッセージ、詳細) HttpsErrorクラスの新しいインスタンスを構築します

プロパティ

財産修飾子タイプ説明
コード関数エラーコードクライアントに返される標準エラー コード。これにより、code.proto で定義されている応答の HTTP ステータス コードも決まります。
詳細未知JSON に変換され、エラー応答に含まれる追加データ。
httpエラーコードHTTPエラーコード提供されたエラー コードのワイヤ形式表現。

メソッド

方法修飾子説明
toJSON()このオブジェクトの JSON シリアル化可能な表現を返します。

https.HttpsError.(コンストラクター)

HttpsErrorクラスの新しいインスタンスを構築します

サイン:

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

パラメーター

パラメータタイプ説明
コード関数エラーコード
メッセージ
詳細未知

https.HttpsError.code

クライアントに返される標準エラー コード。これにより、code.proto で定義されている応答の HTTP ステータス コードも決まります。

サイン:

readonly code: FunctionsErrorCode;

https.HttpsError.details

JSON に変換され、エラー応答に含まれる追加データ。

サイン:

readonly details: unknown;

https.HttpsError.httpErrorCode

提供されたエラー コードのワイヤ形式表現。

サイン:

readonly httpErrorCode: HttpErrorCode;

https.HttpsError.toJSON()

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

サイン:

toJSON(): HttpErrorWireFormat;

戻り値:

HttpErrorWireFormat