Edit

Share via

ServerError class

Package:
@azure/msal-node

Error thrown when there is an error with the server code, for example, unavailability.

Extends
AuthError

Constructors

ServerError(string, string, string, string, number)

Properties

errorNo

Server error number;
status

Http status number;

Inherited Properties

correlationId

CorrelationId associated with the error
errorCode

Short string denoting error
errorMessage

Detailed description of error
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.
subError

Describes the subclass of an error

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
setCorrelationId(string)

Constructor Details

ServerError(string, string, string, string, number) 

new ServerError(errorCode?: string, errorMessage?: string, subError?: string, errorNo?: string, status?: number)

Parameters

errorCode

string

errorMessage

string

subError

string

errorNo

string

status

number

Property Details

errorNo

Server error number;

errorNo?: string

Property Value

string

status

Http status number;

status?: number

Property Value

number

Inherited Property Details

correlationId

CorrelationId associated with the error

correlationId: string

Property Value

string

Inherited From AuthError.correlationId

errorCode

Short string denoting error

errorCode: string

Property Value

string

Inherited From AuthError.errorCode

errorMessage

Detailed description of error

errorMessage: string

Property Value

string

Inherited From AuthError.errorMessage

message 

message: string

Property Value

string

Inherited From AuthError.message

name 

name: string

Property Value

string

Inherited From AuthError.name

stack 

stack?: string

Property Value

string

Inherited From AuthError.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 AuthError.stackTraceLimit

subError

Describes the subclass of an error

subError: string

Property Value

string

Inherited From AuthError.subError

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 AuthError.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 AuthError.prepareStackTrace

setCorrelationId(string) 

function setCorrelationId(correlationId: string)

Parameters

correlationId

string

Inherited From AuthError.setCorrelationId