AuthError class

Paquet:
@azure/msal-common

Classe d’erreur générale levée par la bibliothèque MSAL.js.

Extends

Error

Constructeurs

AuthError(string, string, string)

Propriétés

correlationId

CorrelationId associé à l’erreur
errorCode

Erreur de détection de chaîne courte
errorMessage

Description détaillée de l’erreur
platformBrokerError

PlatformBrokerError par défaut à partir de MsalNodeRuntime lorsque le répartiteur est activé
subError

Décrit la sous-classe d’une erreur

Propriétés héritées

message
name
stack
stackTraceLimit

La Error.stackTraceLimit propriété spécifie le nombre de trames de pile collectées par une trace de pile (qu’elle soit générée par new Error().stack ou Error.captureStackTrace(obj)).

La valeur par défaut est 10 , mais peut être définie à n’importe quel numéro JavaScript valide. Les modifications affecteront toute trace de pile capturée après que la valeur ait été modifiée.

Si elles sont fixées à une valeur non numérique, ou à un nombre négatif, les traces de pile ne captureront aucune trame.

Méthodes

setCorrelationId(string)

Méthodes héritées

captureStackTrace(object, Function)

Crée une .stack propriété sur targetObject, qui, lorsqu’elle est consultée, renvoie une chaîne représentant l’emplacement dans le code où Error.captureStackTrace() il a été appelé.

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

La première ligne de la trace sera précédée de ${myObject.name}: ${myObject.message}.

L’argument optionnel constructorOpt accepte une fonction. Si elle est donnée, toutes les trames au-dessus constructorOptde , y compris constructorOpt, seront omises de la trace de pile générée.

Cet constructorOpt argument est utile pour cacher aux utilisateurs les détails de la génération d’erreurs sur l’implémentation. Exemple :

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

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

Détails du constructeur

AuthError(string, string, string) 

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

Paramètres

errorCode

string

errorMessage

string

suberror

string

Détails de la propriété

correlationId

CorrelationId associé à l’erreur

correlationId: string

Valeur de propriété

string

errorCode

Erreur de détection de chaîne courte

errorCode: string

Valeur de propriété

string

errorMessage

Description détaillée de l’erreur

errorMessage: string

Valeur de propriété

string

platformBrokerError

PlatformBrokerError par défaut à partir de MsalNodeRuntime lorsque le répartiteur est activé

platformBrokerError?: PlatformBrokerError

Valeur de propriété

PlatformBrokerError

subError

Décrit la sous-classe d’une erreur

subError: string

Valeur de propriété

string

Détails de la propriété héritée

message 

message: string

Valeur de propriété

string

héritée de Error.message

name 

name: string

Valeur de propriété

string

héritée de Error.name

stack 

stack?: string

Valeur de propriété

string

héritée de Error.stack

stackTraceLimit

La Error.stackTraceLimit propriété spécifie le nombre de trames de pile collectées par une trace de pile (qu’elle soit générée par new Error().stack ou Error.captureStackTrace(obj)).

La valeur par défaut est 10 , mais peut être définie à n’importe quel numéro JavaScript valide. Les modifications affecteront toute trace de pile capturée après que la valeur ait été modifiée.

Si elles sont fixées à une valeur non numérique, ou à un nombre négatif, les traces de pile ne captureront aucune trame.

static stackTraceLimit: number

Valeur de propriété

number

Hérité de Error.stackTraceLimit

Détails de la méthode

setCorrelationId(string) 

function setCorrelationId(correlationId: string)

Paramètres

correlationId

string

Détails de la méthode héritée

captureStackTrace(object, Function)

Crée une .stack propriété sur targetObject, qui, lorsqu’elle est consultée, renvoie une chaîne représentant l’emplacement dans le code où Error.captureStackTrace() il a été appelé.

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

La première ligne de la trace sera précédée de ${myObject.name}: ${myObject.message}.

L’argument optionnel constructorOpt accepte une fonction. Si elle est donnée, toutes les trames au-dessus constructorOptde , y compris constructorOpt, seront omises de la trace de pile générée.

Cet constructorOpt argument est utile pour cacher aux utilisateurs les détails de la génération d’erreurs sur l’implémentation. Exemple :

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)

Paramètres

targetObject

object

constructorOpt

Function

Hérité de Error.captureStackTrace

prepareStackTrace(Error, CallSite[])

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

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

Paramètres

err

Error

stackTraces

CallSite[]

Retours

any

Hérité de Error.prepareStackTrace