Compartilhar via


MessagingError class

Descreve a classe base para Erro de Mensagens.

Extends

Error

Construtores

MessagingError(string, Error)

Propriedades

address

Endereço ao qual a conexão de rede falhou. Só estará presente se o MessagingError tiver sido instanciado com um Node.js SystemError.

code

Um rótulo de cadeia de caracteres que identifica o erro.

errno

Número de erro fornecido pelo sistema. Só estará presente se o MessagingError tiver sido instanciado com um Node.js SystemError.

info

Detalhes extras sobre o erro.

name

O nome do erro. Valor padrão: "MessagingError".

port

A porta de conexão de rede indisponível. Só estará presente se o MessagingError tiver sido instanciado com um Node.js SystemError.

retryable

Descreve se o erro é retível. Padrão: true.

syscall

Nome da chamada do sistema que disparou o erro. Só estará presente se o MessagingError tiver sido instanciado com um Node.js SystemError.

Propriedades herdadas

message
stack
stackTraceLimit

A Error.stackTraceLimit propriedade especifica o número de quadros de pilha coletados por um rastreamento de pilha (gerado por new Error().stack ou Error.captureStackTrace(obj)).

O valor padrão é 10 but pode ser definido como qualquer número JavaScript válido. As alterações afetarão qualquer rastreamento de pilha capturado após a alteração do valor.

Se definido como um valor diferente do número ou definido como um número negativo, os rastreamentos de pilha não capturarão nenhum quadro.

Métodos herdados

captureStackTrace(object, Function)

Cria uma .stack propriedade em targetObject, que, quando acessada, retorna uma cadeia de caracteres que representa o local no código no qual Error.captureStackTrace() foi chamado.

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

A primeira linha do traço será prefixada com ${myObject.name}: ${myObject.message}.

O argumento opcional constructorOpt aceita uma função. Se fornecido, todos os quadros acima constructorOpt, incluindo constructorOpt, serão omitidos do rastreamento de pilha gerado.

O constructorOpt argumento é útil para ocultar detalhes de implementação da geração de erros do usuário. Por exemplo:

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

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

Detalhes do construtor

MessagingError(string, Error)

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

Parâmetros

message

string

A mensagem de erro que fornece mais informações sobre o erro.

originalError

Error

Um erro cujas propriedades serão copiadas para o MessagingError se a propriedade corresponder a uma encontrada no Node.js SystemError.

Detalhes da propriedade

address

Endereço ao qual a conexão de rede falhou. Só estará presente se o MessagingError tiver sido instanciado com um Node.js SystemError.

address?: string

Valor da propriedade

string

code

Um rótulo de cadeia de caracteres que identifica o erro.

code?: string

Valor da propriedade

string

errno

Número de erro fornecido pelo sistema. Só estará presente se o MessagingError tiver sido instanciado com um Node.js SystemError.

errno?: string | number

Valor da propriedade

string | number

info

Detalhes extras sobre o erro.

info?: any

Valor da propriedade

any

name

O nome do erro. Valor padrão: "MessagingError".

name: string

Valor da propriedade

string

port

A porta de conexão de rede indisponível. Só estará presente se o MessagingError tiver sido instanciado com um Node.js SystemError.

port?: number

Valor da propriedade

number

retryable

Descreve se o erro é retível. Padrão: true.

retryable: boolean

Valor da propriedade

boolean

syscall

Nome da chamada do sistema que disparou o erro. Só estará presente se o MessagingError tiver sido instanciado com um Node.js SystemError.

syscall?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

message

message: string

Valor da propriedade

string

herdado de Error.message

stack

stack?: string

Valor da propriedade

string

Herdado de Error.stack

stackTraceLimit

A Error.stackTraceLimit propriedade especifica o número de quadros de pilha coletados por um rastreamento de pilha (gerado por new Error().stack ou Error.captureStackTrace(obj)).

O valor padrão é 10 but pode ser definido como qualquer número JavaScript válido. As alterações afetarão qualquer rastreamento de pilha capturado após a alteração do valor.

Se definido como um valor diferente do número ou definido como um número negativo, os rastreamentos de pilha não capturarão nenhum quadro.

static stackTraceLimit: number

Valor da propriedade

number

Herdado de Error.stackTraceLimit

Detalhes do método herdado

captureStackTrace(object, Function)

Cria uma .stack propriedade em targetObject, que, quando acessada, retorna uma cadeia de caracteres que representa o local no código no qual Error.captureStackTrace() foi chamado.

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

A primeira linha do traço será prefixada com ${myObject.name}: ${myObject.message}.

O argumento opcional constructorOpt aceita uma função. Se fornecido, todos os quadros acima constructorOpt, incluindo constructorOpt, serão omitidos do rastreamento de pilha gerado.

O constructorOpt argumento é útil para ocultar detalhes de implementação da geração de erros do usuário. Por exemplo:

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)

Parâmetros

targetObject

object

constructorOpt

Function

Herdado de Error.captureStackTrace

prepareStackTrace(Error, CallSite[])

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

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

Parâmetros

err

Error

stackTraces

CallSite[]

Retornos

any

Herdado de Error.prepareStackTrace