共用方式為

ErrorResponse class

套件:
@azure/cosmos

表示 operations 中返回的錯誤回應。

Extends

Error

建構函式

ErrorResponse(string)

屬性

activityId

作活動的唯一標識碼
body

錯誤回應的正文，通常包括錯誤詳細資訊
code

返回狀態或錯誤代碼
diagnostics

與錯誤關聯的詳細診斷資訊。
headers

HTTP 標頭
requestCharge

作的請求費用，表示產生的資源成本。
retryAfterInMilliseconds

注意：請改用 retryAfterInMs
retryAfterInMs

delay （以毫秒為單位）。
substatus

返回的 substatus 代碼

繼承的屬性

message
name
stack
stackTraceLimit

該 Error.stackTraceLimit 屬性指定堆疊跟蹤收集的堆疊幀數（無論是由 new Error().stack 還是 Error.captureStackTrace(obj)生成）。

默認值為 10 but can be set to any valid JavaScript number. 更改將影響在更改值 後 捕獲的任何堆疊跟蹤。

如果設置為非數位值或設置為負數，則堆疊跟蹤將不會捕獲任何幀。

繼承的方法

captureStackTrace(object, Function)

在上創建一個 .stack 屬性，該屬性在訪問時返回一個字串，該字串 targetObject表示調用的代碼 Error.captureStackTrace() 中的位置。

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

跟蹤的第一行將以 為 ${myObject.name}: ${myObject.message}前綴。

optional 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

建構函式詳細資料

ErrorResponse(string) 

new ErrorResponse(message?: string)

參數

message

string

屬性詳細資料

activityId

作活動的唯一標識碼

activityId?: string

屬性值

string

body

錯誤回應的正文，通常包括錯誤詳細資訊

body?: ErrorBody

屬性值

ErrorBody

code

返回狀態或錯誤代碼

code?: string | number

屬性值

string | number

diagnostics

與錯誤關聯的詳細診斷資訊。

diagnostics?: CosmosDiagnostics

屬性值

CosmosDiagnostics

headers

HTTP 標頭

headers?: CosmosHeaders

屬性值

CosmosHeaders

requestCharge

作的請求費用，表示產生的資源成本。

requestCharge?: number

屬性值

number

retryAfterInMilliseconds

注意：請改用 retryAfterInMs

retryAfterInMilliseconds?: number

屬性值

number

retryAfterInMs

delay （以毫秒為單位）。

retryAfterInMs?: number

屬性值

number

substatus

返回的 substatus 代碼

substatus?: 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 but can be set to any valid JavaScript number. 更改將影響在更改值 後 捕獲的任何堆疊跟蹤。

如果設置為非數位值或設置為負數，則堆疊跟蹤將不會捕獲任何幀。

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}前綴。

optional 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