InvalidStateError

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

Error thrown when an operation is attempted in an invalid state.

Remarks

For example, attempting to send text to a TTS provider that is not yet connected, or trying to start a session that is already active. This error is not recoverable — the caller must ensure correct operation ordering.

Error code: 'INVALID_STATE_ERROR'

Example

try {
  tts.sendText('Hello'); // throws if not connected
} catch (error) {
  if (error instanceof InvalidStateError) {
    console.error(`Cannot ${error.context?.attemptedAction} in state ${error.context?.currentState}`);
  }
}

Extends

• CompositeVoiceError

Constructors

Constructor

new InvalidStateError(currentState, attemptedAction): InvalidStateError;

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

Creates a new InvalidStateError.

Parameters

Returns

InvalidStateError

Overrides

CompositeVoiceError.constructor

Properties

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

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

Returns

any

See

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

Inherited from

CompositeVoiceError.prepareStackTrace