RestError class
サービス エンドポイントへの HTTP 要求の結果として発生するエラー。
- Extends
-
Error
プロパティ
| code | エラー コード (存在する場合)。 静的エラー コード プロパティ (REQUEST_SEND_ERROR/PARSE_ERROR) のいずれか、または基になるシステム呼び出し (E_NOENT) からの文字列コードを指定できます。 |
| details | 追加の詳細。 逆シリアル化エラーの場合は、処理された応答を指定できます。 |
| PARSE_ERROR | 受信 HTTP 応答の解析によって発生する可能性のあるエラーを識別するための定数文字列。 通常、不完全なエンコードされた JSON ペイロードなど、形式が正しくない HTTP 本文を示します。 |
| request | 送信要求。 |
| REQUEST_SEND_ERROR | トランスポート層の問題を示す HTTP 要求を行うときに発生する可能性のあるエラーを識別するための定数文字列 (URL のホスト名は DNS 経由で解決できません)。 |
| response | 受信応答。 |
| status |
応答が返された場合の HTTP 状態コード。 |
継承されたプロパティ
| message | |
| name | |
| stack | |
| stack |
デフォルト値は 数値以外の値に設定した場合、または負の数に設定した場合、スタックトレースはフレームをキャプチャしません。 |
継承されたメソッド
| capture |
トレースの最初の行には、接頭辞 オプションの
|
| prepare |
https://v8.dev/docs/stack-trace-api#customizing-stack-traces を参照してください |
コンストラクターの詳細
RestError(string, string, number, WebResourceLike, HttpOperationResponse)
new RestError(message: string, code?: string, statusCode?: number, request?: WebResourceLike, response?: HttpOperationResponse)
パラメーター
- message
-
string
- code
-
string
- statusCode
-
number
- request
- WebResourceLike
- response
- HttpOperationResponse
プロパティの詳細
code
エラー コード (存在する場合)。 静的エラー コード プロパティ (REQUEST_SEND_ERROR/PARSE_ERROR) のいずれか、または基になるシステム呼び出し (E_NOENT) からの文字列コードを指定できます。
code?: string
プロパティ値
string
details
追加の詳細。 逆シリアル化エラーの場合は、処理された応答を指定できます。
details?: unknown
プロパティ値
unknown
PARSE_ERROR
受信 HTTP 応答の解析によって発生する可能性のあるエラーを識別するための定数文字列。 通常、不完全なエンコードされた JSON ペイロードなど、形式が正しくない HTTP 本文を示します。
static PARSE_ERROR: string
プロパティ値
string
request
REQUEST_SEND_ERROR
トランスポート層の問題を示す HTTP 要求を行うときに発生する可能性のあるエラーを識別するための定数文字列 (URL のホスト名は DNS 経由で解決できません)。
static REQUEST_SEND_ERROR: string
プロパティ値
string
response
statusCode
応答が返された場合の HTTP 状態コード。
statusCode?: number
プロパティ値
number
継承されたプロパティの詳細
message
message: string
プロパティ値
string
Error.message から継承された
name
name: string
プロパティ値
string
Error.name から継承された
stack
stack?: string
プロパティ値
string
Error.stack から継承された
stackTraceLimit
Error.stackTraceLimit プロパティは、スタック トレースによって収集されるスタック フレームの数を指定します (new Error().stack によって生成されたか、Error.captureStackTrace(obj)によって生成されたかは問いません)。
デフォルト値は 10 ですが、任意の有効な JavaScript 番号に設定できます。 変更は、値の変更 後に キャプチャされたスタック・トレースに影響します。
数値以外の値に設定した場合、または負の数に設定した場合、スタックトレースはフレームをキャプチャしません。
static stackTraceLimit: number
プロパティ値
number
Error.stackTraceLimit から継承された
継承済みメソッドの詳細
captureStackTrace(object, Function)
.stack に targetObject プロパティを作成します。このプロパティにアクセスすると、Error.captureStackTrace() が呼び出されたコード内の場所を表す文字列が返されます。
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
トレースの最初の行には、接頭辞 ${myObject.name}: ${myObject.message} が付きます。
オプションの constructorOpt 引数は関数を受け入れます。 指定した場合、constructorOpt を含む constructorOpt より上のすべてのフレームは、生成されたスタック トレースから省略されます。
constructorOpt引数は、エラー生成の実装の詳細をユーザーから隠すのに役立ちます。 たとえば、次のようになります。
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();
static function captureStackTrace(targetObject: object, constructorOpt?: Function)
パラメーター
- targetObject
-
object
- constructorOpt
-
Function
Error.captureStackTrace から継承された
prepareStackTrace(Error, CallSite[])
https://v8.dev/docs/stack-trace-api#customizing-stack-traces を参照してください
static function prepareStackTrace(err: Error, stackTraces: CallSite[]): any
パラメーター
- err
-
Error
- stackTraces
-
CallSite[]
戻り値
any
Error.prepareStackTrace から継承された