VoiceAgentConnectionError class

Paket:
@azure/ai-projects

Ein Fehler, der durch die WebSocket-Verbindung ausgelöst wurde.

Extends
VoiceAgentRealtimeError

Konstruktoren

VoiceAgentConnectionError(string, "connectionFailed" | "connectionClosed" | "invalidState" | "operationCancelled" | "sendFailed", { cause?: unknown, closeCode?: number })

Eigenschaften

closeCode

Der WebSocket-Close-Code, wenn der Fehler durch einen Close-Frame verursacht wurde.

Geerbte Eigenschaften

cause

Der zugrunde liegende Fehler, wenn vorhanden.
code

Ein stabiler Code, der die Fehlerkategorie identifiziert.
message
name
stack
stackTraceLimit

Die Error.stackTraceLimit Eigenschaft gibt die Anzahl der Stack-Frames an, die von einem Stack-Trace erfasst werden (unabhängig davon, ob sie von oder new Error().stackgeneriert wurdenError.captureStackTrace(obj)).

Der Standardwert ist 10 , kann aber auf eine beliebige gültige JavaScript-Nummer gesetzt werden. Änderungen wirken sich auf alle Stack-Traces aus, die nach der Änderung des Werts erfasst wurden.

Wenn dieser Wert auf einen Wert festgelegt ist, der keine Zahl ist, oder auf eine negative Zahl, werden bei Stapelüberwachungen keine Frames erfasst.

Geerbte Methoden

captureStackTrace(object, Function)

Erstellt eine .stack Eigenschaft auf targetObject, die beim Zugriff eine Zeichenfolge zurückgibt, die die Position im Code darstellt, an der Error.captureStackTrace() aufgerufen wurde.

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

Der ersten Zeile der Ablaufverfolgung wird das ${myObject.name}: ${myObject.message}Präfix .

Das optionale constructorOpt Argument akzeptiert eine Funktion. Falls angegeben, werden alle Frames über constructorOpt, einschließlich constructorOpt, aus dem generierten Stack-Trace ausgelassen.

Das constructorOpt Argument ist nützlich, um Implementierungsdetails der Fehlergenerierung vor dem Benutzer zu verbergen. Beispiel:

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

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

Details zum Konstruktor

VoiceAgentConnectionError(string, "connectionFailed" | "connectionClosed" | "invalidState" | "operationCancelled" | "sendFailed", { cause?: unknown, closeCode?: number }) 

new VoiceAgentConnectionError(message: string, code: "connectionFailed" | "connectionClosed" | "invalidState" | "operationCancelled" | "sendFailed", options?: { cause?: unknown, closeCode?: number })

Parameter

message

string

code

"connectionFailed" | "connectionClosed" | "invalidState" | "operationCancelled" | "sendFailed"

options

{ cause?: unknown, closeCode?: number }

Details zur Eigenschaft

closeCode

Der WebSocket-Close-Code, wenn der Fehler durch einen Close-Frame verursacht wurde.

closeCode?: number

Eigenschaftswert

number

Geerbte Eigenschaftsdetails

cause

Der zugrunde liegende Fehler, wenn vorhanden.

cause?: unknown

Eigenschaftswert

unknown

Geerbt vonVoiceAgentRealtimeError.cause

code

Ein stabiler Code, der die Fehlerkategorie identifiziert.

code: VoiceAgentRealtimeErrorCode

Eigenschaftswert

VoiceAgentRealtimeErrorCode

Geerbt vonVoiceAgentRealtimeError.code

message 

message: string

Eigenschaftswert

string

Geerbt vonVoiceAgentRealtimeError.message

name 

name: string

Eigenschaftswert

string

Geerbt vonVoiceAgentRealtimeError.name

stack 

stack?: string

Eigenschaftswert

string

Geerbt vonVoiceAgentRealtimeError.stack

stackTraceLimit

Die Error.stackTraceLimit Eigenschaft gibt die Anzahl der Stack-Frames an, die von einem Stack-Trace erfasst werden (unabhängig davon, ob sie von oder new Error().stackgeneriert wurdenError.captureStackTrace(obj)).

Der Standardwert ist 10 , kann aber auf eine beliebige gültige JavaScript-Nummer gesetzt werden. Änderungen wirken sich auf alle Stack-Traces aus, die nach der Änderung des Werts erfasst wurden.

Wenn dieser Wert auf einen Wert festgelegt ist, der keine Zahl ist, oder auf eine negative Zahl, werden bei Stapelüberwachungen keine Frames erfasst.

static stackTraceLimit: number

Eigenschaftswert

number

Geerbt vonVoiceAgentRealtimeError.stackTraceLimit

Details zur geerbten Methode

captureStackTrace(object, Function)

Erstellt eine .stack Eigenschaft auf targetObject, die beim Zugriff eine Zeichenfolge zurückgibt, die die Position im Code darstellt, an der Error.captureStackTrace() aufgerufen wurde.

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

Der ersten Zeile der Ablaufverfolgung wird das ${myObject.name}: ${myObject.message}Präfix .

Das optionale constructorOpt Argument akzeptiert eine Funktion. Falls angegeben, werden alle Frames über constructorOpt, einschließlich constructorOpt, aus dem generierten Stack-Trace ausgelassen.

Das constructorOpt Argument ist nützlich, um Implementierungsdetails der Fehlergenerierung vor dem Benutzer zu verbergen. Beispiel:

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)

Parameter

targetObject

object

constructorOpt

Function

Geerbt vonVoiceAgentRealtimeError.captureStackTrace

prepareStackTrace(Error, CallSite[])

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

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

Parameter

err

Error

stackTraces

CallSite[]

Gibt zurück

any

Geerbt vonVoiceAgentRealtimeError.prepareStackTrace