RestError class

Пакет:
@azure/core-http

Ошибка, полученная из HTTP-запроса к конечной точке службы.

Extends

Error

Конструкторы

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

Свойства

code

Код ошибки, если таковой есть. Может быть одним из свойств статического кода ошибки (REQUEST_SEND_ERROR / PARSE_ERROR) или может быть строковым кодом из базового системного вызова (E_NOENT).
details

Дополнительные сведения. В случае ошибок десериализации может быть обработанным ответом.
PARSE_ERROR

Константная строка для выявления ошибок, которые могут возникать при анализе входящего HTTP-ответа. Обычно указывает неправильно сформированный текст HTTP, например полезные данные JSON в кодировке, которые являются неполными.
request

Исходящий запрос.
REQUEST_SEND_ERROR

Константная строка для выявления ошибок, которые могут возникнуть при выполнении HTTP-запроса, указывающего на проблему с уровнем транспорта (например, имя узла URL-адреса невозможно устранить с помощью DNS.)
response

Входящий ответ.
statusCode

Код состояния HTTP ответа, если он был возвращен.

Унаследованные свойства

message
name
stack
stackTraceLimit

Свойство Error.stackTraceLimit указывает количество кадров стека, собранных трассировкой стека (сгенерированной new Error().stack или Error.captureStackTrace(obj)).

Значение по умолчанию — 10 но может быть установлено на любой допустимый номер JavaScript. Изменения повлияют на любую трассировку стека, захваченную после изменения значения.

Если задано нечисловое значение или установлено отрицательное число, трассировки стека не будут захватывать кадры.

Наследуемые методы

captureStackTrace(object, Function)

Создает свойство .stack на targetObject, которое при доступе возвращает строку, представляющую местоположение в коде, в котором Error.captureStackTrace() был вызван.

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

Первая строка трассировки будет начинаться с префикса ${myObject.name}: ${myObject.message}.

Необязательный constructorOpt аргумент принимает функцию. Если указано, все кадры выше constructorOpt, включая constructorOpt, будут исключены из сгенерированной трассировки стека.

Аргумент constructorOpt полезен для сокрытия от пользователя деталей реализации генерации ошибки. Например:

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

См. https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Сведения о конструкторе

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

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

Параметры

message

string

code

string

statusCode

number

request
WebResourceLike
response
HttpOperationResponse

Сведения о свойстве

code

Код ошибки, если таковой есть. Может быть одним из свойств статического кода ошибки (REQUEST_SEND_ERROR / PARSE_ERROR) или может быть строковым кодом из базового системного вызова (E_NOENT).

code?: string

Значение свойства

string

details

Дополнительные сведения. В случае ошибок десериализации может быть обработанным ответом.

details?: unknown

Значение свойства

unknown

PARSE_ERROR

Константная строка для выявления ошибок, которые могут возникать при анализе входящего HTTP-ответа. Обычно указывает неправильно сформированный текст HTTP, например полезные данные JSON в кодировке, которые являются неполными.

static PARSE_ERROR: string

Значение свойства

string

request

Исходящий запрос.

request?: WebResourceLike

Значение свойства

WebResourceLike

REQUEST_SEND_ERROR

Константная строка для выявления ошибок, которые могут возникнуть при выполнении HTTP-запроса, указывающего на проблему с уровнем транспорта (например, имя узла URL-адреса невозможно устранить с помощью DNS.)

static REQUEST_SEND_ERROR: string

Значение свойства

string

response

Входящий ответ.

response?: HttpOperationResponse

Значение свойства

HttpOperationResponse

statusCode

Код состояния HTTP ответа, если он был возвращен.

statusCode?: number

Значение свойства

number

Сведения об унаследованном свойстве

message 

message: string

Значение свойства

string

наследуется от Error.message

name 

name: string

Значение свойства

string

унаследован от Error.name

stack 

stack?: string

Значение свойства

string

наследуется от Error.stack

stackTraceLimit

Свойство Error.stackTraceLimit указывает количество кадров стека, собранных трассировкой стека (сгенерированной new Error().stack или Error.captureStackTrace(obj)).

Значение по умолчанию — 10 но может быть установлено на любой допустимый номер JavaScript. Изменения повлияют на любую трассировку стека, захваченную после изменения значения.

Если задано нечисловое значение или установлено отрицательное число, трассировки стека не будут захватывать кадры.

static stackTraceLimit: number

Значение свойства

number

наследуется от Error.stackTraceLimit

Сведения о наследуемом методе

captureStackTrace(object, Function)

Создает свойство .stack на targetObject, которое при доступе возвращает строку, представляющую местоположение в коде, в котором Error.captureStackTrace() был вызван.

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

Первая строка трассировки будет начинаться с префикса ${myObject.name}: ${myObject.message}.

Необязательный constructorOpt аргумент принимает функцию. Если указано, все кадры выше constructorOpt, включая constructorOpt, будут исключены из сгенерированной трассировки стека.

Аргумент constructorOpt полезен для сокрытия от пользователя деталей реализации генерации ошибки. Например:

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)

Параметры

targetObject

object

constructorOpt

Function

наследуется от Error.captureStackTrace

prepareStackTrace(Error, CallSite[])

См. https://v8.dev/docs/stack-trace-api#customizing-stack-traces

static function prepareStackTrace(err: Error, stackTraces: CallSite[]): any

Параметры

err

Error

stackTraces

CallSite[]

Возвращаемое значение

any

наследуется от ошибки.prepareStackTrace