RestError class

Um tipo de erro personalizado para solicitações de pipeline com falha.

Extends

Error

Construtores

RestError(string, RestErrorOptions)

Propriedades

code

O código do erro em si (use estática no RestError, se possível.)

details

Propriedade de bônus definida pelo site de lançamento.

PARSE_ERROR

Isso significa que a análise da resposta do servidor falhou. Pode ter sido malformado.

request

A solicitação que foi feita.

REQUEST_SEND_ERROR

Algo deu errado ao fazer a solicitação. Isso significa que a solicitação real falhou por algum motivo, como um problema de DNS ou a conexão que está sendo perdida.

response

A resposta recebida (se houver).)

statusCode

O código de status HTTP da solicitação (se aplicável).)

Propriedades herdadas

message
name
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

RestError(string, RestErrorOptions)

new RestError(message: string, options?: RestErrorOptions)

Parâmetros

message

string

Detalhes da propriedade

code

O código do erro em si (use estática no RestError, se possível.)

code?: string

Valor da propriedade

string

details

Propriedade de bônus definida pelo site de lançamento.

details?: unknown

Valor da propriedade

unknown

PARSE_ERROR

Isso significa que a análise da resposta do servidor falhou. Pode ter sido malformado.

static PARSE_ERROR: string

Valor da propriedade

string

request

A solicitação que foi feita.

request?: PipelineRequest

Valor da propriedade

REQUEST_SEND_ERROR

Algo deu errado ao fazer a solicitação. Isso significa que a solicitação real falhou por algum motivo, como um problema de DNS ou a conexão que está sendo perdida.

static REQUEST_SEND_ERROR: string

Valor da propriedade

string

response

A resposta recebida (se houver).)

response?: PipelineResponse

Valor da propriedade

statusCode

O código de status HTTP da solicitação (se aplicável).)

statusCode?: number

Valor da propriedade

number

Detalhes das propriedades herdadas

message

message: string

Valor da propriedade

string

herdado de Error.message

name

name: string

Valor da propriedade

string

herdado de Error.name

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