AuthError class

Пакет:
@azure/msal-common

Общий класс ошибок, вызванный библиотекой MSAL.js.

Extends

Error

Конструкторы

AuthError(string, string, string)

Свойства

correlationId

CorrelationId, связанный с ошибкой
errorCode

Ошибка краткой строки, обозначающая
errorMessage

Подробное описание ошибки
platformBrokerError

Default PlatformBrokerError из MsalNodeRuntime при включении брокера
subError

Описание подкласса ошибки

Унаследованные свойства

message
name
stack
stackTraceLimit

Свойство Error.stackTraceLimit указывает количество стековых кадров, собираемых стековой трассой (независимо от того, порождается ли она или new Error().stackError.captureStackTrace(obj)).

Значение по умолчанию — 10 но может быть установлено на любой действительный JavaScript-номер. Изменения повлияют на любой трассировочный стек, захваченный после изменения значения.

Если установить нечисловое значение или отрицательное число, стековые трассы не захватывают кадры.

Методы

setCorrelationId(string)

Наследуемые методы

captureStackTrace(object, Function)

Создаёт свойство .stack на targetObject, которое при доступе возвращает строку, представляющую расположение в коде, Error.captureStackTrace() где был вызван.

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

Первая строка трассы будет иметь префикс ${myObject.name}: ${myObject.message}.

Необязательный constructorOpt аргумент принимает функцию. Если задан, все кадры выше constructorOpt, включая constructorOpt, будут опущены из сгенерированной трассы стека.

Аргумент constructorOpt полезен для сокрытия деталей генерации ошибок от пользователя. Например:

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

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

Сведения о конструкторе

AuthError(string, string, string) 

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

Параметры

errorCode

string

errorMessage

string

suberror

string

Сведения о свойстве

correlationId

CorrelationId, связанный с ошибкой

correlationId: string

Значение свойства

string

errorCode

Ошибка краткой строки, обозначающая

errorCode: string

Значение свойства

string

errorMessage

Подробное описание ошибки

errorMessage: string

Значение свойства

string

platformBrokerError

Default PlatformBrokerError из MsalNodeRuntime при включении брокера

platformBrokerError?: PlatformBrokerError

Значение свойства

PlatformBrokerError

subError

Описание подкласса ошибки

subError: string

Значение свойства

string

Сведения об унаследованном свойстве

message 

message: string

Значение свойства

string

Унаследовано от Error.message

name 

name: string

Значение свойства

string

Унаследовано от Error.name

stack 

stack?: string

Значение свойства

string

Унаследовано от Ошибка.стек

stackTraceLimit

Свойство Error.stackTraceLimit указывает количество стековых кадров, собираемых стековой трассой (независимо от того, порождается ли она или new Error().stackError.captureStackTrace(obj)).

Значение по умолчанию — 10 но может быть установлено на любой действительный JavaScript-номер. Изменения повлияют на любой трассировочный стек, захваченный после изменения значения.

Если установить нечисловое значение или отрицательное число, стековые трассы не захватывают кадры.

static stackTraceLimit: number

Значение свойства

number

Унаследованный от Error.stackTraceLimit

Сведения о методе

setCorrelationId(string) 

function setCorrelationId(correlationId: string)

Параметры

correlationId

string

Сведения о наследуемом методе

captureStackTrace(object, Function)

Создаёт свойство .stack на targetObject, которое при доступе возвращает строку, представляющую расположение в коде, Error.captureStackTrace() где был вызван.

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

Первая строка трассы будет иметь префикс ${myObject.name}: ${myObject.message}.

Необязательный constructorOpt аргумент принимает функцию. Если задан, все кадры выше constructorOpt, включая constructorOpt, будут опущены из сгенерированной трассы стека.

Аргумент constructorOpt полезен для сокрытия деталей генерации ошибок от пользователя. Например:

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)

Параметры

targetObject

object

constructorOpt

Function

Унаследованный от Error.captureStackTrace

prepareStackTrace(Error, CallSite[])

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

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

Параметры

err

Error

stackTraces

CallSite[]

Возвращаемое значение

any

Унаследованный от Error.prepareStackTrace