Partilhar via

RestError class

  • Referência
Pacote:
@typespec/ts-http-runtime

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áticas em RestError se possível.)
details

Propriedade 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

O pedido que foi feito. Esta propriedade não é enumerável.
REQUEST_SEND_ERROR

Algo correu mal ao fazer o pedido. Isso significa que a solicitação real falhou por algum motivo, como um problema de DNS ou a conexão sendo perdida.
response

A resposta recebida (se houver). Esta propriedade não é enumerável.
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 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

RestError(string, RestErrorOptions) 

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

Parâmetros

message

string

options
RestErrorOptions

Detalhes de Propriedade

code

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

code?: string

Valor de Propriedade

string

details

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

details?: unknown

Valor de Propriedade

unknown

PARSE_ERROR

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

static PARSE_ERROR: string

Valor de Propriedade

string

request

O pedido que foi feito. Esta propriedade não é enumerável.

request?: PipelineRequest

Valor de Propriedade

PipelineRequest

REQUEST_SEND_ERROR

Algo correu mal ao fazer o pedido. Isso significa que a solicitação real falhou por algum motivo, como um problema de DNS ou a conexão sendo perdida.

static REQUEST_SEND_ERROR: string

Valor de Propriedade

string

response

A resposta recebida (se houver). Esta propriedade não é enumerável.

response?: PipelineResponse

Valor de Propriedade

PipelineResponse

statusCode

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

statusCode?: number

Valor de Propriedade

number

Detalhes da Propriedade Herdada

message 

message: string

Valor de Propriedade

string

herdado de Error.message

name 

name: string

Valor de Propriedade

string

herdada de Error.name

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