Partilhar via


MessagingError class

Descreve a classe base para Erro de mensagens.

Extends

Error

Construtores

MessagingError(string)

Propriedades

condition

A condição de erro.

info

Qualquer informação de erro adicional fornecida pelo serviço.

name

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

retryable

Descreve se o erro pode ser repetido. Padrão: true.

translated

O erro foi traduzido? Padrão: true.

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 mas pode ser definido como qualquer número JavaScript válido. As alterações afetarão qualquer rastreamento de pilha capturado após o valor ter sido alterado.

Se definido como um valor não numérico 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 no 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[])

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

Detalhes do Construtor

MessagingError(string)

new MessagingError(message: string)

Parâmetros

message

string

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

Detalhes de Propriedade

condition

A condição de erro.

condition?: string

Valor de Propriedade

string

info

Qualquer informação de erro adicional fornecida pelo serviço.

info?: any

Valor de Propriedade

any

name

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

name: string

Valor de Propriedade

string

retryable

Descreve se o erro pode ser repetido. Padrão: true.

retryable: boolean

Valor de Propriedade

boolean

translated

O erro foi traduzido? Padrão: true.

translated: boolean

Valor de Propriedade

boolean

Detalhes da Propriedade Herdada

message

message: string

Valor de Propriedade

string

herdado de Error.message

stack

stack?: string

Valor de 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 mas pode ser definido como qualquer número JavaScript válido. As alterações afetarão qualquer rastreamento de pilha capturado após o valor ter sido alterado.

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

static stackTraceLimit: number

Valor de Propriedade

number

herdado de Error.stackTraceLimit

Detalhes do Método Herdado

captureStackTrace(object, Function)

Cria uma .stack propriedade no 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[])

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

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

Parâmetros

err

Error

stackTraces

CallSite[]

Devoluções

any

herdado de Error.prepareStackTrace