MessagingError class

  • Reference
Package:
@azure/event-hubs

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
prepareStackTrace

Optional override for formatting stack traces

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

Inherited Methods

captureStackTrace(object, Function)

Create .stack property on a target object

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

prepareStackTrace

Optional override for formatting stack traces

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

static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Property Value

(err: Error, stackTraces: CallSite[]) => any

Inherited From Error.prepareStackTrace

stack 

stack?: string

Property Value

string

Inherited From Error.stack

stackTraceLimit 

static stackTraceLimit: number

Property Value

number

Inherited From Error.stackTraceLimit

Inherited Method Details

captureStackTrace(object, Function)

Create .stack property on a target object

static function captureStackTrace(targetObject: object, constructorOpt?: Function)

Parameters

targetObject

object

constructorOpt

Function

Inherited From Error.captureStackTrace