你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。

MessagingError class

描述消息传送错误的基类。

扩展

Error

属性

address

网络连接失败的地址。 仅当 MessagingError 被实例化为 Node.js SystemError时才存在。

code

标识错误的字符串标签。

errno

系统提供的错误号。 仅当 MessagingError 被实例化为 Node.js SystemError时才存在。

info

有关错误的额外详细信息。

name

错误名称。 默认值:“MessagingError”。

port

不可用的网络连接端口。 仅当 MessagingError 被实例化为 Node.js SystemError时才存在。

retryable

描述错误是否可重试。 默认值:true。

syscall

触发错误的系统调用的名称。 仅当 MessagingError 被实例化为 Node.js SystemError时才存在。

继承属性

message
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

构造函数详细信息

MessagingError(string, Error)

new MessagingError(message: string, originalError?: Error)

参数

message

string

提供有关错误的详细信息的错误消息。

originalError

Error

如果属性与在 Node.js SystemError上找到的属性匹配,则其属性将复制到 MessagingError。

属性详细信息

address

网络连接失败的地址。 仅当 MessagingError 被实例化为 Node.js SystemError时才存在。

address?: string

属性值

string

code

标识错误的字符串标签。

code?: string

属性值

string

errno

系统提供的错误号。 仅当 MessagingError 被实例化为 Node.js SystemError时才存在。

errno?: string | number

属性值

string | number

info

有关错误的额外详细信息。

info?: any

属性值

any

name

错误名称。 默认值:“MessagingError”。

name: string

属性值

string

port

不可用的网络连接端口。 仅当 MessagingError 被实例化为 Node.js SystemError时才存在。

port?: number

属性值

number

retryable

描述错误是否可重试。 默认值:true。

retryable: boolean

属性值

boolean

syscall

触发错误的系统调用的名称。 仅当 MessagingError 被实例化为 Node.js SystemError时才存在。

syscall?: string

属性值

string

继承属性详细信息

message

message: string

属性值

string

继承自 Error.message

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