Compartir a través de

RestError class

Paquete:
@azure/core-http

Error resultante de una solicitud HTTP a un punto de conexión de servicio.

Extends

Error

Constructores

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

Propiedades

code

Código de error, si existe. Puede ser una de las propiedades de código de error estáticas (REQUEST_SEND_ERROR /PARSE_ERROR) o puede ser un código de cadena desde una llamada del sistema subyacente (E_NOENT).
details

Cualquier detalle adicional. En el caso de errores de deserialización, puede ser la respuesta procesada.
PARSE_ERROR

Cadena constante para identificar los errores que pueden surgir al analizar una respuesta HTTP entrante. Normalmente indica un cuerpo HTTP con formato incorrecto, como una carga JSON codificada que está incompleta.
request

Solicitud saliente.
REQUEST_SEND_ERROR

Cadena constante para identificar errores que pueden surgir al realizar una solicitud HTTP que indica un problema con la capa de transporte (por ejemplo, el nombre de host de la dirección URL no se puede resolver a través de DNS).
response

Respuesta entrante.
statusCode

Código de estado HTTP de la respuesta, si se devolvió uno.

Propiedades heredadas

message
name
stack
stackTraceLimit

La Error.stackTraceLimit propiedad especifica el número de marcos de pila recopilados por un seguimiento de pila (ya sea generado por new Error().stack o Error.captureStackTrace(obj)).

El valor predeterminado es 10 pero se puede establecer en cualquier número de JavaScript válido. Los cambios afectarán a cualquier seguimiento de pila capturado después de que se haya cambiado el valor.

Si se establece en un valor que no es un número, o se establece en un número negativo, los seguimientos de pila no capturarán ningún fotograma.

Métodos heredados

captureStackTrace(object, Function)

Crea una .stack propiedad en targetObject, que, cuando se tiene acceso, devuelve una cadena que representa la ubicación en el código en el que Error.captureStackTrace() se llamó.

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

La primera línea de la traza tendrá el prefijo ${myObject.name}: ${myObject.message}.

El argumento opcional constructorOpt acepta una función. Si se proporciona, todos los fotogramas anteriores constructorOpt, incluido constructorOpt, se omitirán del seguimiento de pila generado.

El constructorOpt argumento es útil para ocultar al usuario los detalles de implementación de la generación de errores. Por ejemplo:

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

Detalles del constructor

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

Detalles de las propiedades

code

Código de error, si existe. Puede ser una de las propiedades de código de error estáticas (REQUEST_SEND_ERROR /PARSE_ERROR) o puede ser un código de cadena desde una llamada del sistema subyacente (E_NOENT).

code?: string

Valor de propiedad

string

details

Cualquier detalle adicional. En el caso de errores de deserialización, puede ser la respuesta procesada.

details?: unknown

Valor de propiedad

unknown

PARSE_ERROR

Cadena constante para identificar los errores que pueden surgir al analizar una respuesta HTTP entrante. Normalmente indica un cuerpo HTTP con formato incorrecto, como una carga JSON codificada que está incompleta.

static PARSE_ERROR: string

Valor de propiedad

string

request

Solicitud saliente.

request?: WebResourceLike

Valor de propiedad

WebResourceLike

REQUEST_SEND_ERROR

Cadena constante para identificar errores que pueden surgir al realizar una solicitud HTTP que indica un problema con la capa de transporte (por ejemplo, el nombre de host de la dirección URL no se puede resolver a través de DNS).

static REQUEST_SEND_ERROR: string

Valor de propiedad

string

response

Respuesta entrante.

response?: HttpOperationResponse

Valor de propiedad

HttpOperationResponse

statusCode

Código de estado HTTP de la respuesta, si se devolvió uno.

statusCode?: number

Valor de propiedad

number

Detalles de las propiedades heredadas

message 

message: string

Valor de propiedad

string

Heredado de Error.message

name 

name: string

Valor de propiedad

string

heredado de Error.name

stack 

stack?: string

Valor de propiedad

string

heredado de Error.stack

stackTraceLimit

La Error.stackTraceLimit propiedad especifica el número de marcos de pila recopilados por un seguimiento de pila (ya sea generado por new Error().stack o Error.captureStackTrace(obj)).

El valor predeterminado es 10 pero se puede establecer en cualquier número de JavaScript válido. Los cambios afectarán a cualquier seguimiento de pila capturado después de que se haya cambiado el valor.

Si se establece en un valor que no es un número, o se establece en un número negativo, los seguimientos de pila no capturarán ningún fotograma.

static stackTraceLimit: number

Valor de propiedad

number

heredado de Error.stackTraceLimit

Detalles de los métodos heredados

captureStackTrace(object, Function)

Crea una .stack propiedad en targetObject, que, cuando se tiene acceso, devuelve una cadena que representa la ubicación en el código en el que Error.captureStackTrace() se llamó.

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

La primera línea de la traza tendrá el prefijo ${myObject.name}: ${myObject.message}.

El argumento opcional constructorOpt acepta una función. Si se proporciona, todos los fotogramas anteriores constructorOpt, incluido constructorOpt, se omitirán del seguimiento de pila generado.

El constructorOpt argumento es útil para ocultar al usuario los detalles de implementación de la generación de errores. Por ejemplo:

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

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

Devoluciones

any

heredado de Error.prepareStackTrace