Edit

Share via

UnsupportedEnvironmentError class

Package:
@azure/msal-browser
Extends
CustomAuthError

Constructors

UnsupportedEnvironmentError(string)

Inherited Properties

correlationId
error
errorCodes
errorDescription
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

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

UnsupportedEnvironmentError(string) 

new UnsupportedEnvironmentError(correlationId?: string)

Parameters

correlationId

string

Inherited Property Details

correlationId 

correlationId?: string

Property Value

string

Inherited From CustomAuthError.correlationId

error 

error: string

Property Value

string

Inherited From CustomAuthError.error

errorCodes 

errorCodes?: number[]

Property Value

number[]

Inherited From CustomAuthError.errorCodes

errorDescription 

errorDescription?: string

Property Value

string

Inherited From CustomAuthError.errorDescription

message 

message: string

Property Value

string

Inherited From CustomAuthError.message

name 

name: string

Property Value

string

Inherited From CustomAuthError.name

stack 

stack?: string

Property Value

string

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

subError 

subError?: string

Property Value

string

Inherited From CustomAuthError.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 CustomAuthError.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 CustomAuthError.prepareStackTrace