ProcessError class

パッケージ:
@azure/core-process

プロセスの解決や実行中にエラーが発生しました。

キャプチャされた出力は列挙不可能であるため、通常のログやシリアライズで誤って露出することはありません。

Extends

Error

コンストラクター

ProcessError(string, ProcessErrorOptions)

プロセスエラーを生みます。

プロパティ

code

オペレーティングシステムのエラーコードまたはプロセス終了コード。
killed

プロセスが中止されたかどうか。
signal

その過程を終わらせた信号。
stderr

利用可能な場合は捕獲標準誤差。
stdout

利用可能な場合はキャプチャされた標準出力。

継承されたプロパティ

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」を参照してください。

コンストラクターの詳細

ProcessError(string, ProcessErrorOptions)

プロセスエラーを生みます。

new ProcessError(message: string, options?: ProcessErrorOptions)

パラメーター

message

string

コマンド引数や出力を含まないメッセージです。

options
ProcessErrorOptions

構造化されたプロセスの失敗詳細。

プロパティの詳細

code

オペレーティングシステムのエラーコードまたはプロセス終了コード。

code: string | number | null

プロパティ値

string | number | null

killed

プロセスが中止されたかどうか。

killed: boolean

プロパティ値

boolean

signal

その過程を終わらせた信号。

signal: Signals | null

プロパティ値

Signals | null

stderr

利用可能な場合は捕獲標準誤差。

stderr: string | Buffer | undefined

プロパティ値

string | Buffer | undefined

stdout

利用可能な場合はキャプチャされた標準出力。

stdout: string | Buffer | undefined

プロパティ値

string | Buffer | undefined

継承されたプロパティの詳細

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(エラー.stackトレースリミット)

継承済みメソッドの詳細

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