Skip to content

ProviderConnectionError

Error thrown when a provider fails to establish a connection.

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

Error thrown when a provider fails to establish a connection.

Remarks

Typically caused by network issues, invalid credentials, or service unavailability. This error is recoverable — the connection can be retried after a delay.

Error code: 'PROVIDER_CONNECTION_ERROR'

Example

try {
  await tts.connect();
} catch (error) {
  if (error instanceof ProviderConnectionError && error.recoverable) {
    // Retry after delay
    await delay(1000);
    await tts.connect();
  }
}

Extends

Constructors

Constructor

new ProviderConnectionError(providerName, cause?): ProviderConnectionError;

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

Creates a new ProviderConnectionError.

Parameters

ParameterTypeDescription
providerNamestringThe name of the provider that failed to connect.
cause?ErrorThe underlying error that caused the connection failure.

Returns

ProviderConnectionError

Overrides

CompositeVoiceError.constructor

Properties

PropertyModifierTypeDescriptionInherited fromDefined in
codereadonlystringMachine-readable error code (e.g., 'PROVIDER_INIT_ERROR', 'TIMEOUT_ERROR').CompositeVoiceError.codesrc/utils/errors.ts:60
contextreadonlyRecord<string, unknown> | undefinedOptional structured context data for diagnostic purposes.CompositeVoiceError.contextsrc/utils/errors.ts:72
messagepublicstring-CompositeVoiceError.messagenode_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
namepublicstring-CompositeVoiceError.namenode_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
recoverablereadonlybooleanWhether 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.recoverablesrc/utils/errors.ts:69
stack?publicstring-CompositeVoiceError.stacknode_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
stackTraceLimitstaticnumberThe 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.stackTraceLimitnode_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

ParameterType
targetObjectobject
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

ParameterType
errError
stackTracesCallSite[]

Returns

any

See

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

Inherited from

CompositeVoiceError.prepareStackTrace

© 2026 CompositeVoice. All rights reserved.

Font size
Contrast
Motion
Transparency