RestError class

  • Reference
Package:
@azure/core-http

An error resulting from an HTTP request to a service endpoint.

Extends

Error

Constructors

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

Properties

code

The error code, if any. Can be one of the static error code properties (REQUEST_SEND_ERROR / PARSE_ERROR) or can be a string code from an underlying system call (E_NOENT).
details

Any additional details. In the case of deserialization errors, can be the processed response.
PARSE_ERROR

A constant string to identify errors that may arise from parsing an incoming HTTP response. Usually indicates a malformed HTTP body, such as an encoded JSON payload that is incomplete.
request

Outgoing request.
REQUEST_SEND_ERROR

A constant string to identify errors that may arise when making an HTTP request that indicates an issue with the transport layer (e.g. the hostname of the URL cannot be resolved via DNS.)
response

Incoming response.
statusCode

The HTTP status code of the response, if one was returned.

Inherited Properties

message
name
prepareStackTrace

Optional override for formatting stack traces

See https://v8.dev/docs/stack-trace-api#customizing-stack-traces
stack
stackTraceLimit

Inherited Methods

captureStackTrace(object, Function)

Create .stack property on a target object

Constructor Details

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

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

Parameters

message

string

code

string

statusCode

number

request
WebResourceLike
response
HttpOperationResponse

Property Details

code

The error code, if any. Can be one of the static error code properties (REQUEST_SEND_ERROR / PARSE_ERROR) or can be a string code from an underlying system call (E_NOENT).

code?: string

Property Value

string

details

Any additional details. In the case of deserialization errors, can be the processed response.

details?: unknown

Property Value

unknown

PARSE_ERROR

A constant string to identify errors that may arise from parsing an incoming HTTP response. Usually indicates a malformed HTTP body, such as an encoded JSON payload that is incomplete.

static PARSE_ERROR: string

Property Value

string

request

Outgoing request.

request?: WebResourceLike

Property Value

WebResourceLike

REQUEST_SEND_ERROR

A constant string to identify errors that may arise when making an HTTP request that indicates an issue with the transport layer (e.g. the hostname of the URL cannot be resolved via DNS.)

static REQUEST_SEND_ERROR: string

Property Value

string

response

Incoming response.

response?: HttpOperationResponse

Property Value

HttpOperationResponse

statusCode

The HTTP status code of the response, if one was returned.

statusCode?: number

Property Value

number

Inherited Property Details

message 

message: string

Property Value

string

Inherited From Error.message

name 

name: string

Property Value

string

Inherited From Error.name

prepareStackTrace

Optional override for formatting stack traces

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

static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Property Value

(err: Error, stackTraces: CallSite[]) => any

Inherited From Error.prepareStackTrace

stack 

stack?: string

Property Value

string

Inherited From Error.stack

stackTraceLimit 

static stackTraceLimit: number

Property Value

number

Inherited From Error.stackTraceLimit

Inherited Method Details

captureStackTrace(object, Function)

Create .stack property on a target object

static function captureStackTrace(targetObject: object, constructorOpt?: Function)

Parameters

targetObject

object

constructorOpt

Function

Inherited From Error.captureStackTrace