AuthError class

Pakiet:
@azure/msal-common

Ogólna klasa błędów zgłaszana przez bibliotekę MSAL.js.

Rozszerzenie

Error

Konstruktory

AuthError(string, string, string)

Właściwości

correlationId

CorrelationId skojarzony z błędem
errorCode

Krótki ciąg oznaczający błąd
errorMessage

Szczegółowy opis błędu
platformBrokerError

Domyślna wartość PlatformBrokerError z msalNodeRuntime po włączeniu brokera
subError

Opisuje podklasę błędu

Właściwości dziedziczone

message
name
stack
stackTraceLimit

Właściwość ta Error.stackTraceLimit określa liczbę ramek stosu zebranych przez ślad stosu (niezależnie od tego, czy generowany przez new Error().stack lub Error.captureStackTrace(obj)).

Domyślna wartość to, 10 ale może być ustawiona na dowolny poprawny numer JavaScript. Zmiany wpłyną na wszelkie ślady stosu przechwycone po zmianie wartości.

Jeśli ustawione są na wartość nieliczbową lub ujemną, ślady stosu nie przechwytują żadnych klatek.

Metody

setCorrelationId(string)

Metody dziedziczone

captureStackTrace(object, Function)

Tworzy właściwość .stack na targetObject, która po utworzeniu zwraca ciąg reprezentujący lokalizację w kodzie, w którym Error.captureStackTrace() został wywołany.

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

Pierwsza linia śladu będzie poprzedzona przez .${myObject.name}: ${myObject.message}

Argument opcjonalny constructorOpt akceptuje funkcję. Jeśli podane, wszystkie ramki powyżej constructorOpt, włącznie z constructorOpt, zostaną pominięte z generowanego śladu stosu.

Argument ten constructorOpt jest przydatny do ukrywania szczegółów generowania błędów implementacyjnych przed użytkownikiem. Przykład:

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

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

Szczegóły konstruktora

AuthError(string, string, string) 

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

Parametry

errorCode

string

errorMessage

string

suberror

string

Szczegóły właściwości

correlationId

CorrelationId skojarzony z błędem

correlationId: string

Wartość właściwości

string

errorCode

Krótki ciąg oznaczający błąd

errorCode: string

Wartość właściwości

string

errorMessage

Szczegółowy opis błędu

errorMessage: string

Wartość właściwości

string

platformBrokerError

Domyślna wartość PlatformBrokerError z msalNodeRuntime po włączeniu brokera

platformBrokerError?: PlatformBrokerError

Wartość właściwości

PlatformBrokerError

subError

Opisuje podklasę błędu

subError: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

message 

message: string

Wartość właściwości

string

dziedziczone z Error.message

name 

name: string

Wartość właściwości

string

dziedziczone z Error.name

stack 

stack?: string

Wartość właściwości

string

dziedziczone z Error.stack

stackTraceLimit

Właściwość ta Error.stackTraceLimit określa liczbę ramek stosu zebranych przez ślad stosu (niezależnie od tego, czy generowany przez new Error().stack lub Error.captureStackTrace(obj)).

Domyślna wartość to, 10 ale może być ustawiona na dowolny poprawny numer JavaScript. Zmiany wpłyną na wszelkie ślady stosu przechwycone po zmianie wartości.

Jeśli ustawione są na wartość nieliczbową lub ujemną, ślady stosu nie przechwytują żadnych klatek.

static stackTraceLimit: number

Wartość właściwości

number

Dziedziczone od Error.stackTraceLimit

Szczegóły metody

setCorrelationId(string) 

function setCorrelationId(correlationId: string)

Parametry

correlationId

string

Szczegóły metody dziedziczonej

captureStackTrace(object, Function)

Tworzy właściwość .stack na targetObject, która po utworzeniu zwraca ciąg reprezentujący lokalizację w kodzie, w którym Error.captureStackTrace() został wywołany.

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

Pierwsza linia śladu będzie poprzedzona przez .${myObject.name}: ${myObject.message}

Argument opcjonalny constructorOpt akceptuje funkcję. Jeśli podane, wszystkie ramki powyżej constructorOpt, włącznie z constructorOpt, zostaną pominięte z generowanego śladu stosu.

Argument ten constructorOpt jest przydatny do ukrywania szczegółów generowania błędów implementacyjnych przed użytkownikiem. Przykład:

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

Dziedziczone od Błąd.captureStackTrace

prepareStackTrace(Error, CallSite[])

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

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

Parametry

err

Error

stackTraces

CallSite[]

Zwraca

any

Dziedziczone od Error.prepareStackTrace