Share via

ErrorResponse class

Package:
@azure/cosmos

Represents an error response returned in operations.

Extends

Error

Constructors

ErrorResponse(string)

Properties

activityId

unique identifier for the operation's activity
body

body of the error response, typically including error details
code

status or error code returned
diagnostics

Detailed diagnostic information associated with the error.
headers

HTTP headers
requestCharge

The request charge of the operation, representing the resource cost incurred.
retryAfterInMilliseconds

Note: Use retryAfterInMs instead
retryAfterInMs

delay (in milliseconds) before retrying the operation.
substatus

substatus code returned

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

ErrorResponse(string) 

new ErrorResponse(message?: string)

Parameters

message

string

Property Details

activityId

unique identifier for the operation's activity

activityId?: string

Property Value

string

body

body of the error response, typically including error details

body?: ErrorBody

Property Value

ErrorBody

code

status or error code returned

code?: string | number

Property Value

string | number

diagnostics

Detailed diagnostic information associated with the error.

diagnostics?: CosmosDiagnostics

Property Value

CosmosDiagnostics

headers

HTTP headers

headers?: CosmosHeaders

Property Value

CosmosHeaders

requestCharge

The request charge of the operation, representing the resource cost incurred.

requestCharge?: number

Property Value

number

retryAfterInMilliseconds

Note: Use retryAfterInMs instead

retryAfterInMilliseconds?: number

Property Value

number

retryAfterInMs

delay (in milliseconds) before retrying the operation.

retryAfterInMs?: number

Property Value

number

substatus

substatus code returned

substatus?: 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