Class: TunnelError

Error thrown when remote tunnel operations fail. Use for tunnel connection issues, message parsing failures, etc.

Example

throw new TunnelError("No tunnel connection available");
throw new TunnelError("Failed to parse WebSocket message", { cause: parseError });

Extends

• AppKitError

Constructors

Constructor

new TunnelError(message: string, options?: {
  cause?: Error;
  clientMessage?: string;
  context?: Record<string, unknown>;
}): TunnelError;

Parameters

Returns

TunnelError

Inherited from

AppKitError.constructor

Properties

_clientMessage?

protected readonly optional _clientMessage: string;

Client-safe error message. When set, callers serializing the error to a client (SSE, HTTP body) MUST prefer clientMessage over message — message may contain raw upstream / SDK text including statement fragments, internal object names, and correlation IDs.

Subclasses can set this in their constructor for a fixed sanitized string. When unset, clientMessage defaults to a generic per-code string (see the getter), and the raw message is kept server-side only.

Inherited from

AppKitError._clientMessage

cause?

readonly optional cause: Error;

Optional cause of the error

Inherited from

AppKitError.cause

code

readonly code: "TUNNEL_ERROR" = "TUNNEL_ERROR";

Error code for programmatic error handling

Overrides

AppKitError.code

context?

readonly optional context: Record<string, unknown>;

Additional context for the error

Inherited from

AppKitError.context

isRetryable

readonly isRetryable: true = true;

Whether this error type is generally safe to retry

Overrides

AppKitError.isRetryable

statusCode

readonly statusCode: 502 = 502;

HTTP status code suggestion (can be overridden)

Overrides

AppKitError.statusCode

Accessors

clientMessage

Get Signature

get clientMessage(): string;

Sanitized message safe to forward to clients. Override in subclasses if a more specific default is appropriate.

Returns

string

Inherited from

AppKitError.clientMessage

Methods

toJSON()

toJSON(): Record<string, unknown>;

Convert error to JSON for logging/serialization. Sensitive values in context are automatically redacted.

Returns

Record<string, unknown>

Inherited from

AppKitError.toJSON

toString()

toString(): string;

Create a human-readable string representation

Returns

string

Inherited from

AppKitError.toString

fetchFailed()

static fetchFailed(path: string, cause?: Error): TunnelError;

Create a tunnel error for asset fetch failure

Parameters

Returns

TunnelError

getterNotRegistered()

static getterNotRegistered(): TunnelError;

Create a tunnel error for missing tunnel getter

Returns

TunnelError

noConnection()

static noConnection(): TunnelError;

Create a tunnel error for no available connection

Returns

TunnelError

parseError()

static parseError(messageType: string, cause?: Error): TunnelError;

Create a tunnel error for message parsing failure

Parameters

Returns

TunnelError