WebSocketError

Error thrown when a WebSocket operation fails.

Remarks

Covers WebSocket connection errors, send failures, and protocol violations. This error is recoverable — the WebSocket can be reconnected.

Error code: 'WEBSOCKET_ERROR'

See

WebSocketManager for the connection manager that throws this error.

Extends

CompositeVoiceError

Constructors

Constructor

new WebSocketError(message, code?): WebSocketError;

Defined in: src/utils/errors.ts:391

Creates a new WebSocketError.

Parameters

Parameter	Type	Description
`message`	`string`	Description of the WebSocket error.
`code?`	`number`	The WebSocket close code, if applicable.

Returns

WebSocketError

Overrides

CompositeVoiceError.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
`code`	`readonly`	`string`	Machine-readable error code (e.g., `'PROVIDER_INIT_ERROR'`, `'TIMEOUT_ERROR'`).	`CompositeVoiceError`.`code`	src/utils/errors.ts:60
`context`	`readonly`	`Record`<`string`, `unknown`> \| `undefined`	Optional structured context data for diagnostic purposes.	`CompositeVoiceError`.`context`	src/utils/errors.ts:72
`message`	`public`	`string`	-	`CompositeVoiceError`.`message`	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
`name`	`public`	`string`	-	`CompositeVoiceError`.`name`	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
`recoverable`	`readonly`	`boolean`	Whether the error is potentially recoverable. Remarks When `true`, the application or SDK may attempt to recover (e.g., retry a connection). When `false`, user intervention is typically required.	`CompositeVoiceError`.`recoverable`	src/utils/errors.ts:69
`stack?`	`public`	`string`	-	`CompositeVoiceError`.`stack`	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
`stackTraceLimit`	`static`	`number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	`CompositeVoiceError`.`stackTraceLimit`	node_modules/.pnpm/@types+node@20.19.22/node_modules/@types/node/globals.d.ts:68

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@20.19.22/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

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

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

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();

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

CompositeVoiceError.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@20.19.22/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

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

Inherited from

CompositeVoiceError.prepareStackTrace