VoiceAgentConnectionError class

Pakiet:
@azure/ai-projects

Błąd wywołany przez połączenie WebSocket.

Rozszerzenie
VoiceAgentRealtimeError

Konstruktory

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

Właściwości

closeCode

Kod zamykający WebSocket, gdy błąd był spowodowany zamkniętą klatką.

Właściwości dziedziczone

cause

Podstawowy błąd, gdy jest dostępny.
code

Stabilny kod identyfikujący kategorię błędu.
message
name
stack
stackTraceLimit

Właściwość Error.stackTraceLimit określa liczbę ramek stosu zebranych przez ślad stosu (niezależnie od tego, czy jest generowany przez new Error().stack lub Error.captureStackTrace(obj)).

Wartość domyślna to 10 ale może być ustawiona na dowolny prawidłowy numer JavaScript. Zmiany będą miały wpływ na wszystkie ślady stosu przechwycone po zmianie wartości.

Jeśli ustawiona jest wartość inna niż liczba lub liczba ujemna, ślady stosu nie będą przechwytywać żadnych ramek.

Metody dziedziczone

captureStackTrace(object, Function)

Tworzy właściwość .stack w programie targetObject, która po uzyskaniu dostępu zwraca ciąg reprezentujący lokalizację w kodzie, w którym Error.captureStackTrace() została wywołana.

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

Pierwszy wiersz śladu będzie poprzedzony prefiksem ${myObject.name}: ${myObject.message}.

constructorOpt Opcjonalny argument akceptuje funkcję. Jeśli zostanie podana, wszystkie klatki powyżej constructorOpt, w tym constructorOpt, zostaną pominięte w wygenerowanym śladzie stosu.

Argument constructorOpt jest przydatny do ukrywania szczegółów implementacji generowania błędów przed użytkownikiem. Przykład:

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

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

Szczegóły konstruktora

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 })

Parametry

message

string

code

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

options

{ cause?: unknown, closeCode?: number }

Szczegóły właściwości

closeCode

Kod zamykający WebSocket, gdy błąd był spowodowany zamkniętą klatką.

closeCode?: number

Wartość właściwości

number

Szczegóły właściwości dziedziczonej

cause

Podstawowy błąd, gdy jest dostępny.

cause?: unknown

Wartość właściwości

unknown

Dziedziczone zVoiceAgentRealtimeError.cause

code

Stabilny kod identyfikujący kategorię błędu.

code: VoiceAgentRealtimeErrorCode

Wartość właściwości

VoiceAgentRealtimeErrorCode

Odziedziczone zVoiceAgentRealtimeError.code

message 

message: string

Wartość właściwości

string

Dziedziczone zVoiceAgentRealtimeError.message

name 

name: string

Wartość właściwości

string

Odziedziczone poVoiceAgentRealtimeError.name

stack 

stack?: string

Wartość właściwości

string

Dziedziczone zVoiceAgentRealtimeError.stack

stackTraceLimit

Właściwość Error.stackTraceLimit określa liczbę ramek stosu zebranych przez ślad stosu (niezależnie od tego, czy jest generowany przez new Error().stack lub Error.captureStackTrace(obj)).

Wartość domyślna to 10 ale może być ustawiona na dowolny prawidłowy numer JavaScript. Zmiany będą miały wpływ na wszystkie ślady stosu przechwycone po zmianie wartości.

Jeśli ustawiona jest wartość inna niż liczba lub liczba ujemna, ślady stosu nie będą przechwytywać żadnych ramek.

static stackTraceLimit: number

Wartość właściwości

number

Dziedziczone zVoiceAgentRealtimeError.stackTraceLimit

Szczegóły metody dziedziczonej

captureStackTrace(object, Function)

Tworzy właściwość .stack w programie targetObject, która po uzyskaniu dostępu zwraca ciąg reprezentujący lokalizację w kodzie, w którym Error.captureStackTrace() została wywołana.

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

Pierwszy wiersz śladu będzie poprzedzony prefiksem ${myObject.name}: ${myObject.message}.

constructorOpt Opcjonalny argument akceptuje funkcję. Jeśli zostanie podana, wszystkie klatki powyżej constructorOpt, w tym constructorOpt, zostaną pominięte w wygenerowanym śladzie stosu.

Argument constructorOpt jest przydatny do ukrywania szczegółów implementacji generowania błędów przed użytkownikiem. Przykład:

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)

Parametry

targetObject

object

constructorOpt

Function

Dziedziczone zVoiceAgentRealtimeError.captureStackTrace

prepareStackTrace(Error, CallSite[])

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

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

Parametry

err

Error

stackTraces

CallSite[]

Zwraca

any

Dziedziczone zVoiceAgentRealtimeError.prepareStackTrace