Partager via

CallError class

Paquet:
@azure/communication-react

Erreur levée à partir des méthodes API avec état ayant échoué.

Extends

Error

Constructeurs

CallError(CallErrorTarget, Error, Date)

doit être un (innerError en tant que CommunicationServicesError)

Propriétés

code

Code primaire de l’erreur d’appel
innerError

Erreur levée par la méthode du Kit de développement logiciel (SDK) ayant échoué.
subCode

Sous-code pour l’erreur d’appel
target

Cible de méthode API qui a échoué.
timestamp

Horodatage ajouté à l’erreur par la couche avec état.

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 sur n’importe quel numéro JavaScript valide. Les modifications affecteront toute trace de pile capturée après la modification de la valeur.

S’ils sont définis sur une valeur non numérique ou sur un nombre négatif, les traces de pile ne captureront aucune trame.

Méthodes héritées

captureStackTrace(object, Function)

Crée une .stack propriété le , targetObjectqui, lorsqu’elle est accédée, renvoie une chaîne représentant l’emplacement dans le code auquel Error.captureStackTrace() a été appelé.

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

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

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

L’argument constructorOpt est utile pour masquer à l’utilisateur les détails de l’implémentation de la génération d’erreurs. Par 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

CallError(CallErrorTarget, Error, Date)

doit être un (innerError en tant que CommunicationServicesError)

new CallError(target: CallErrorTarget, innerError: Error, timestamp?: Date)

Paramètres

target
CallErrorTarget
innerError

Error

timestamp

Date

Détails de la propriété

code

Code primaire de l’erreur d’appel

code?: number

Valeur de propriété

number

innerError

Erreur levée par la méthode du Kit de développement logiciel (SDK) ayant échoué.

innerError: Error

Valeur de propriété

Error

subCode

Sous-code pour l’erreur d’appel

subCode?: number

Valeur de propriété

number

target

Cible de méthode API qui a échoué.

target: CallErrorTarget

Valeur de propriété

CallErrorTarget

timestamp

Horodatage ajouté à l’erreur par la couche avec état.

timestamp: Date

Valeur de propriété

Date

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 sur n’importe quel numéro JavaScript valide. Les modifications affecteront toute trace de pile capturée après la modification de la valeur.

S’ils sont définis sur une valeur non numérique ou sur un nombre négatif, les traces de pile ne captureront aucune trame.

static stackTraceLimit: number

Valeur de propriété

number

héritée de Error.stackTraceLimit

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

captureStackTrace(object, Function)

Crée une .stack propriété le , targetObjectqui, lorsqu’elle est accédée, renvoie une chaîne représentant l’emplacement dans le code auquel Error.captureStackTrace() a été appelé.

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

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

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

L’argument constructorOpt est utile pour masquer à l’utilisateur les détails de l’implémentation de la génération d’erreurs. Par 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ée 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ée de Error.prepareStackTrace