Share via

RestError class

  • Reference
Package:
@azure/core-rest-pipeline

A custom error type for failed pipeline requests.

Extends

Error

Constructors

RestError(string, RestErrorOptions)

Properties

code

The code of the error itself (use statics on RestError if possible.)
details

Bonus property set by the throw site.
PARSE_ERROR

This means that parsing the response from the server failed. It may have been malformed.
request

The request that was made. This property is non-enumerable.
REQUEST_SEND_ERROR

Something went wrong when making the request. This means the actual request failed for some reason, such as a DNS issue or the connection being lost.
response

The response received (if any.) This property is non-enumerable.
statusCode

The HTTP status code of the request (if applicable.)

Inherited Properties

message
name
stack
stackTraceLimit

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited Methods

captureStackTrace(object, Function)

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

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

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

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

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

Constructor Details

RestError(string, RestErrorOptions) 

new RestError(message: string, options?: RestErrorOptions)

Parameters

message

string

options
RestErrorOptions

Property Details

code

The code of the error itself (use statics on RestError if possible.)

code?: string

Property Value

string

details

Bonus property set by the throw site.

details?: unknown

Property Value

unknown

PARSE_ERROR

This means that parsing the response from the server failed. It may have been malformed.

static PARSE_ERROR: string

Property Value

string

request

The request that was made. This property is non-enumerable.

request?: PipelineRequest

Property Value

PipelineRequest

REQUEST_SEND_ERROR

Something went wrong when making the request. This means the actual request failed for some reason, such as a DNS issue or the connection being lost.

static REQUEST_SEND_ERROR: string

Property Value

string

response

The response received (if any.) This property is non-enumerable.

response?: PipelineResponse

Property Value

PipelineResponse

statusCode

The HTTP status code of the request (if applicable.)

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

stack 

stack?: string

Property Value

string

Inherited From Error.stack

stackTraceLimit

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

static stackTraceLimit: number

Property Value

number

Inherited From Error.stackTraceLimit

Inherited Method Details

captureStackTrace(object, Function)

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

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

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

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)

Parameters

targetObject

object

constructorOpt

Function

Inherited From Error.captureStackTrace

prepareStackTrace(Error, CallSite[])

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

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

Inherited From Error.prepareStackTrace