Compartilhar via

RestError class

Pacote:
@azure/core-http

Um erro resultante de uma solicitação HTTP para um ponto de extremidade de serviço.

Extends

Error

Construtores

RestError(string, string, number, WebResourceLike, HttpOperationResponse)

Propriedades

code

O código de erro, se houver. Pode ser uma das propriedades de código de erro estático (REQUEST_SEND_ERROR/PARSE_ERROR) ou pode ser um código de cadeia de caracteres de uma chamada do sistema subjacente (E_NOENT).
details

Quaisquer detalhes adicionais. No caso de erros de desserialização, pode ser a resposta processada.
PARSE_ERROR

Uma cadeia de caracteres constante para identificar erros que podem surgir da análise de uma resposta HTTP de entrada. Geralmente indica um corpo HTTP malformado, como uma carga JSON codificada incompleta.
request

Solicitação de saída.
REQUEST_SEND_ERROR

Uma cadeia de caracteres constante para identificar erros que podem surgir ao fazer uma solicitação HTTP que indica um problema com a camada de transporte (por exemplo, o nome do host da URL não pode ser resolvido via DNS.)
response

Resposta de entrada.
statusCode

O código de status HTTP da resposta, se um tiver sido retornado.

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, string, number, WebResourceLike, HttpOperationResponse) 

new RestError(message: string, code?: string, statusCode?: number, request?: WebResourceLike, response?: HttpOperationResponse)

Parâmetros

message

string

code

string

statusCode

number

request
WebResourceLike
response
HttpOperationResponse

Detalhes da propriedade

code

O código de erro, se houver. Pode ser uma das propriedades de código de erro estático (REQUEST_SEND_ERROR/PARSE_ERROR) ou pode ser um código de cadeia de caracteres de uma chamada do sistema subjacente (E_NOENT).

code?: string

Valor da propriedade

string

details

Quaisquer detalhes adicionais. No caso de erros de desserialização, pode ser a resposta processada.

details?: unknown

Valor da propriedade

unknown

PARSE_ERROR

Uma cadeia de caracteres constante para identificar erros que podem surgir da análise de uma resposta HTTP de entrada. Geralmente indica um corpo HTTP malformado, como uma carga JSON codificada incompleta.

static PARSE_ERROR: string

Valor da propriedade

string

request

Solicitação de saída.

request?: WebResourceLike

Valor da propriedade

WebResourceLike

REQUEST_SEND_ERROR

Uma cadeia de caracteres constante para identificar erros que podem surgir ao fazer uma solicitação HTTP que indica um problema com a camada de transporte (por exemplo, o nome do host da URL não pode ser resolvido via DNS.)

static REQUEST_SEND_ERROR: string

Valor da propriedade

string

response

Resposta de entrada.

response?: HttpOperationResponse

Valor da propriedade

HttpOperationResponse

statusCode

O código de status HTTP da resposta, se um tiver sido retornado.

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