次の方法で共有

RestError class

  • リファレンス
パッケージ:
@typespec/ts-http-runtime

失敗したパイプライン要求のカスタム エラーの種類。

Extends

Error

コンストラクター

RestError(string, RestErrorOptions)

プロパティ

code

エラー自体のコード (可能な場合は RestError で statics を使用します)。
details

スロー サイトによって設定された Bonus プロパティ。
PARSE_ERROR

これは、サーバーからの応答の解析に失敗したことを意味します。 形式が正しくない可能性があります。
request

行われた要求。 このプロパティは列挙できません。
REQUEST_SEND_ERROR

要求を行うときに問題が発生しました。 これは、DNS の問題や接続の切断など、何らかの理由で実際の要求が失敗したことを意味します。
response

受信した応答 (存在する場合)。このプロパティは列挙できません。
statusCode

要求の HTTP 状態コード (該当する場合)。

継承されたプロパティ

message
name
stack
stackTraceLimit

Error.stackTraceLimit プロパティは、スタック トレースによって収集されるスタック フレームの数を指定します (new Error().stack によって生成されたか、Error.captureStackTrace(obj)によって生成されたかは問いません)。

デフォルト値は 10 ですが、任意の有効な JavaScript 番号に設定できます。 変更は、値の変更 後に キャプチャされたスタック・トレースに影響します。

数値以外の値に設定した場合、または負の数に設定した場合、スタックトレースはフレームをキャプチャしません。

継承されたメソッド

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();
prepareStackTrace(Error, CallSite[])

https://v8.dev/docs/stack-trace-api#customizing-stack-traces を参照してください

コンストラクターの詳細

RestError(string, RestErrorOptions) 

new RestError(message: string, options?: RestErrorOptions)

パラメーター

message

string

options
RestErrorOptions

プロパティの詳細

code

エラー自体のコード (可能な場合は RestError で statics を使用します)。

code?: string

プロパティ値

string

details

スロー サイトによって設定された Bonus プロパティ。

details?: unknown

プロパティ値

unknown

PARSE_ERROR

これは、サーバーからの応答の解析に失敗したことを意味します。 形式が正しくない可能性があります。

static PARSE_ERROR: string

プロパティ値

string

request

行われた要求。 このプロパティは列挙できません。

request?: PipelineRequest

プロパティ値

PipelineRequest

REQUEST_SEND_ERROR

要求を行うときに問題が発生しました。 これは、DNS の問題や接続の切断など、何らかの理由で実際の要求が失敗したことを意味します。

static REQUEST_SEND_ERROR: string

プロパティ値

string

response

受信した応答 (存在する場合)。このプロパティは列挙できません。

response?: PipelineResponse

プロパティ値

PipelineResponse

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 から継承された