AuthError class

Classe de erro geral gerada pela biblioteca de MSAL.js.

Extends

Error

Propriedades

correlationId

CorrelationId associado ao erro

errorCode

Erro de denotação de cadeia de caracteres curta

errorMessage

Descrição detalhada do erro

platformBrokerError

PlatformBrokerError padrão do MsalNodeRuntime quando o agente está habilitado

subError

Descreve a subclasse de um erro

Propriedades herdadas

message
name
stack
stackTraceLimit

A Error.stackTraceLimit propriedade especifica o número de quadros de pilha coletados por um traço de pilha (seja gerado por new Error().stack ou Error.captureStackTrace(obj)).

O valor padrão é 10 , mas pode ser definido para qualquer número JavaScript válido. Mudanças afetarão qualquer rastreio de pilha capturado após a alteração do valor.

Se definidos para um valor que não seja número, ou para um número negativo, os traços de pilha não capturarão nenhum quadro.

Métodos herdados

captureStackTrace(object, Function)

Cria uma .stack propriedade em targetObject, que, ao ser acessada, retorna uma string representando a localização no código em que Error.captureStackTrace() foi chamada.

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

A primeira linha do traço será precedida por ${myObject.name}: ${myObject.message}.

O argumento opcional constructorOpt aceita uma função. Se forem dados, todos os quadros acima constructorOptde , incluindo constructorOpt, serão omitidos do traço de pilha gerado.

O constructorOpt argumento é útil para esconder detalhes da implementação sobre a geração de erros do usuário. Por exemplo:

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

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

Detalhes do construtor

AuthError(string, string, string)

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

Parâmetros

errorCode

string

errorMessage

string

suberror

string

Detalhes da propriedade

correlationId

CorrelationId associado ao erro

correlationId: string

Valor da propriedade

string

errorCode

Erro de denotação de cadeia de caracteres curta

errorCode: string

Valor da propriedade

string

errorMessage

Descrição detalhada do erro

errorMessage: string

Valor da propriedade

string

platformBrokerError

PlatformBrokerError padrão do MsalNodeRuntime quando o agente está habilitado

platformBrokerError?: PlatformBrokerError

Valor da propriedade

subError

Descreve a subclasse de um erro

subError: string

Valor da propriedade

string

Detalhes das propriedades herdadas

message

message: string

Valor da propriedade

string

herdado de Error.message

name

name: string

Valor da propriedade

string

herdado de Error.name

stack

stack?: string

Valor da propriedade

string

Herdado de Error.stack

stackTraceLimit

A Error.stackTraceLimit propriedade especifica o número de quadros de pilha coletados por um traço de pilha (seja gerado por new Error().stack ou Error.captureStackTrace(obj)).

O valor padrão é 10 , mas pode ser definido para qualquer número JavaScript válido. Mudanças afetarão qualquer rastreio de pilha capturado após a alteração do valor.

Se definidos para um valor que não seja número, ou para um número negativo, os traços de pilha não capturarão nenhum quadro.

static stackTraceLimit: number

Valor da propriedade

number

Herdado de Error.stackTraceLimit

Detalhes do método

setCorrelationId(string)

function setCorrelationId(correlationId: string)

Parâmetros

correlationId

string

Detalhes do método herdado

captureStackTrace(object, Function)

Cria uma .stack propriedade em targetObject, que, ao ser acessada, retorna uma string representando a localização no código em que Error.captureStackTrace() foi chamada.

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

A primeira linha do traço será precedida por ${myObject.name}: ${myObject.message}.

O argumento opcional constructorOpt aceita uma função. Se forem dados, todos os quadros acima constructorOptde , incluindo constructorOpt, serão omitidos do traço de pilha gerado.

O constructorOpt argumento é útil para esconder detalhes da implementação sobre a geração de erros do usuário. Por exemplo:

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)

Parâmetros

targetObject

object

constructorOpt

Function

Herdado de Error.captureStackTrace

prepareStackTrace(Error, CallSite[])

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

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

Parâmetros

err

Error

stackTraces

CallSite[]

Retornos

any

Herdado de Error.prepareStackTrace