AuthError class

Pakket:
@azure/msal-common

Algemene foutklasse die is gegenereerd door de MSAL.js-bibliotheek.

Uitbreiding

Error

Constructors

AuthError(string, string, string)

Eigenschappen

correlationId

CorrelationId gekoppeld aan de fout
errorCode

Korte tekenreeks die fout aangeeft
errorMessage

Gedetailleerde beschrijving van fout
platformBrokerError

StandaardPlatformBrokerError van MsalNodeRuntime wanneer broker is ingeschakeld
subError

Beschrijft de subklasse van een fout

Overgenomen eigenschappen

message
name
stack
stackTraceLimit

De Error.stackTraceLimit eigenschap specificeert het aantal stackframes dat door een stacktrace wordt verzameld (of het nu wordt gegenereerd door new Error().stack of Error.captureStackTrace(obj)).

De standaardwaarde is 10 , maar kan worden ingesteld op elk geldig JavaScript-nummer. Wijzigingen beïnvloeden elke stacktrace die wordt vastgelegd nadat de waarde is gewijzigd.

Als ze worden ingesteld op een niet-getalwaarde, of op een negatief getal, zullen stacktraces geen frames vastleggen.

Methoden

setCorrelationId(string)

Overgenomen methoden

captureStackTrace(object, Function)

Maakt een .stack eigenschap aan op targetObject, die bij benadering een string teruggeeft die de locatie in de code waarop Error.captureStackTrace() werd aangeroepen de locatie vertegenwoordigt.

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

De eerste regel van de trace wordt voorafgegaan door ${myObject.name}: ${myObject.message}.

Het optionele constructorOpt argument accepteert een functie. Als gegeven, worden alle frames boven constructorOpt, inclusief constructorOpt, weggelaten uit de gegenereerde stacktrace.

Het constructorOpt argument is nuttig om implementatiedetails van foutgeneratie voor de gebruiker te verbergen. Bijvoorbeeld:

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

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

Constructordetails

AuthError(string, string, string) 

new AuthError(errorCode?: string, errorMessage?: string, suberror?: string)

Parameters

errorCode

string

errorMessage

string

suberror

string

Eigenschapdetails

correlationId

CorrelationId gekoppeld aan de fout

correlationId: string

Waarde van eigenschap

string

errorCode

Korte tekenreeks die fout aangeeft

errorCode: string

Waarde van eigenschap

string

errorMessage

Gedetailleerde beschrijving van fout

errorMessage: string

Waarde van eigenschap

string

platformBrokerError

StandaardPlatformBrokerError van MsalNodeRuntime wanneer broker is ingeschakeld

platformBrokerError?: PlatformBrokerError

Waarde van eigenschap

PlatformBrokerError

subError

Beschrijft de subklasse van een fout

subError: string

Waarde van eigenschap

string

Details van overgenomen eigenschap

message 

message: string

Waarde van eigenschap

string

overgenomen van Error.message

name 

name: string

Waarde van eigenschap

string

overgenomen van Error.name

stack 

stack?: string

Waarde van eigenschap

string

overgenomen van Error.stack

stackTraceLimit

De Error.stackTraceLimit eigenschap specificeert het aantal stackframes dat door een stacktrace wordt verzameld (of het nu wordt gegenereerd door new Error().stack of Error.captureStackTrace(obj)).

De standaardwaarde is 10 , maar kan worden ingesteld op elk geldig JavaScript-nummer. Wijzigingen beïnvloeden elke stacktrace die wordt vastgelegd nadat de waarde is gewijzigd.

Als ze worden ingesteld op een niet-getalwaarde, of op een negatief getal, zullen stacktraces geen frames vastleggen.

static stackTraceLimit: number

Waarde van eigenschap

number

Geërfd van Error.stackTraceLimit

Methodedetails

setCorrelationId(string) 

function setCorrelationId(correlationId: string)

Parameters

correlationId

string

Details overgenomen methode

captureStackTrace(object, Function)

Maakt een .stack eigenschap aan op targetObject, die bij benadering een string teruggeeft die de locatie in de code waarop Error.captureStackTrace() werd aangeroepen de locatie vertegenwoordigt.

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

De eerste regel van de trace wordt voorafgegaan door ${myObject.name}: ${myObject.message}.

Het optionele constructorOpt argument accepteert een functie. Als gegeven, worden alle frames boven constructorOpt, inclusief constructorOpt, weggelaten uit de gegenereerde stacktrace.

Het constructorOpt argument is nuttig om implementatiedetails van foutgeneratie voor de gebruiker te verbergen. Bijvoorbeeld:

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

Geërfd van Error.captureStackTrace

prepareStackTrace(Error, CallSite[])

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

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

Parameters

err

Error

stackTraces

CallSite[]

Retouren

any

Geërfd van Error.prepareStackTrace