Compartilhar via

RestError class

Pacote:
@azure/ms-rest-js
Extends

Error

Construtores

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

Propriedades

body
code
PARSE_ERROR
request
REQUEST_ABORTED_ERROR
REQUEST_SEND_ERROR
response
statusCode

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, any) 

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

Parâmetros

message

string

code

string

statusCode

number

request
WebResourceLike
response
HttpOperationResponse
body

any

Detalhes da propriedade

body 

body?: any

Valor da propriedade

any

code 

code?: string

Valor da propriedade

string

PARSE_ERROR 

static PARSE_ERROR: string

Valor da propriedade

string

request 

request?: WebResourceLike

Valor da propriedade

WebResourceLike

REQUEST_ABORTED_ERROR 

static REQUEST_ABORTED_ERROR: string

Valor da propriedade

string

REQUEST_SEND_ERROR 

static REQUEST_SEND_ERROR: string

Valor da propriedade

string

response 

response?: HttpOperationResponse

Valor da propriedade

HttpOperationResponse

statusCode 

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