AuthError class

Obecná třída chyby vyvolaná knihovnou MSAL.js

Extends

Error

Vlastnosti

correlationId

ID korelace přidružené k chybě

errorCode

Krátká chyba označující řetězec

errorMessage

Podrobný popis chyby

platformBrokerError

Výchozí platformBrokerError z MsalNodeRuntime při povolení zprostředkovatele

subError

Popisuje podtřídu chyby.

Zděděné vlastnosti

message
name
stack
stackTraceLimit

Vlastnost Error.stackTraceLimit určuje počet stackových rámců shromážděných stopovou stopou (ať už generovaných nebo new Error().stackError.captureStackTrace(obj)).

Výchozí hodnota je 10 , ale může být nastavena na libovolné platné JavaScriptové číslo. Změny ovlivní jakoukoli stopu zásobníku zachycenou po změně hodnoty.

Pokud jsou nastaveny na nečíselnou hodnotu nebo záporné číslo, stopy zásobníku nezachytí žádné snímky.

Zděděné metody

captureStackTrace(object, Function)

Vytvoří vlastnost .stack na targetObject, která při přístupu vrátí řetězec reprezentující místo v kódu, na kterém Error.captureStackTrace() bylo voláno.

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

První řádek stopy bude předponou ${myObject.name}: ${myObject.message}.

Volitelný constructorOpt argument přijímá funkci. Pokud je dáno, všechny rámce nad constructorOpt, včetně constructorOpt, budou z generované stopy zásobníku vynechány.

Tento constructorOpt argument je užitečný pro skrývání detailů generování chyb před uživatelem. Například:

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

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

Podrobnosti konstruktoru

AuthError(string, string, string)

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

Parametry

errorCode

string

errorMessage

string

suberror

string

Podrobnosti vlastnosti

correlationId

ID korelace přidružené k chybě

correlationId: string

Hodnota vlastnosti

string

errorCode

Krátká chyba označující řetězec

errorCode: string

Hodnota vlastnosti

string

errorMessage

Podrobný popis chyby

errorMessage: string

Hodnota vlastnosti

string

platformBrokerError

Výchozí platformBrokerError z MsalNodeRuntime při povolení zprostředkovatele

platformBrokerError?: PlatformBrokerError

Hodnota vlastnosti

subError

Popisuje podtřídu chyby.

subError: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

message

message: string

Hodnota vlastnosti

string

zděděno z Error.message

name

name: string

Hodnota vlastnosti

string

zděděno z Error.name

stack

stack?: string

Hodnota vlastnosti

string

zděděno ze zásobníku Error.stack

stackTraceLimit

Vlastnost Error.stackTraceLimit určuje počet stackových rámců shromážděných stopovou stopou (ať už generovaných nebo new Error().stackError.captureStackTrace(obj)).

Výchozí hodnota je 10 , ale může být nastavena na libovolné platné JavaScriptové číslo. Změny ovlivní jakoukoli stopu zásobníku zachycenou po změně hodnoty.

Pokud jsou nastaveny na nečíselnou hodnotu nebo záporné číslo, stopy zásobníku nezachytí žádné snímky.

static stackTraceLimit: number

Hodnota vlastnosti

number

Děděno od Error.stackTraceLimit

Podrobnosti metody

setCorrelationId(string)

function setCorrelationId(correlationId: string)

Parametry

correlationId

string

Podrobnosti zděděných metod

captureStackTrace(object, Function)

Vytvoří vlastnost .stack na targetObject, která při přístupu vrátí řetězec reprezentující místo v kódu, na kterém Error.captureStackTrace() bylo voláno.

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

První řádek stopy bude předponou ${myObject.name}: ${myObject.message}.

Volitelný constructorOpt argument přijímá funkci. Pokud je dáno, všechny rámce nad constructorOpt, včetně constructorOpt, budou z generované stopy zásobníku vynechány.

Tento constructorOpt argument je užitečný pro skrývání detailů generování chyb před uživatelem. Například:

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)

Parametry

targetObject

object

constructorOpt

Function

Děděno od Error.captureStackTrace

prepareStackTrace(Error, CallSite[])

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

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

Parametry

err

Error

stackTraces

CallSite[]

Návraty

any

Děděno od Error.prepareStackTrace