Share via

MessagingError class

  • Reference
Package:
@azure/service-bus

Describes the base class for Messaging Error.

Extends

Error

Constructors

MessagingError(string, Error)

Properties

address

Address to which the network connection failed. Only present if the MessagingError was instantiated with a Node.js SystemError.
code

A string label that identifies the error.
errno

System-provided error number. Only present if the MessagingError was instantiated with a Node.js SystemError.
info

Extra details about the error.
name

The error name. Default value: "MessagingError".
port

The unavailable network connection port. Only present if the MessagingError was instantiated with a Node.js SystemError.
retryable

Describes whether the error is retryable. Default: true.
syscall

Name of the system call that triggered the error. Only present if the MessagingError was instantiated with a Node.js SystemError.

Inherited Properties

message
stack
stackTraceLimit

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited Methods

captureStackTrace(object, Function)

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

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

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

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[])

See https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Constructor Details

MessagingError(string, Error) 

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

Parameters

message

string

The error message that provides more information about the error.

originalError

Error

An error whose properties will be copied to the MessagingError if the property matches one found on the Node.js SystemError.

Property Details

address

Address to which the network connection failed. Only present if the MessagingError was instantiated with a Node.js SystemError.

address?: string

Property Value

string

code

A string label that identifies the error.

code?: string

Property Value

string

errno

System-provided error number. Only present if the MessagingError was instantiated with a Node.js SystemError.

errno?: string | number

Property Value

string | number

info

Extra details about the error.

info?: any

Property Value

any

name

The error name. Default value: "MessagingError".

name: string

Property Value

string

port

The unavailable network connection port. Only present if the MessagingError was instantiated with a Node.js SystemError.

port?: number

Property Value

number

retryable

Describes whether the error is retryable. Default: true.

retryable: boolean

Property Value

boolean

syscall

Name of the system call that triggered the error. Only present if the MessagingError was instantiated with a Node.js SystemError.

syscall?: string

Property Value

string

Inherited Property Details

message 

message: string

Property Value

string

Inherited From Error.message

stack 

stack?: string

Property Value

string

Inherited From Error.stack

stackTraceLimit

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

static stackTraceLimit: number

Property Value

number

Inherited From Error.stackTraceLimit

Inherited Method Details

captureStackTrace(object, Function)

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

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

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

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)

Parameters

targetObject

object

constructorOpt

Function

Inherited From Error.captureStackTrace

prepareStackTrace(Error, CallSite[])

See https://v8.dev/docs/stack-trace-api#customizing-stack-traces

static function prepareStackTrace(err: Error, stackTraces: CallSite[]): any

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

Inherited From Error.prepareStackTrace