Class: ConnectionError

Error thrown when a connection or network operation fails. Use for database pool errors, API failures, timeouts, etc.

Example

throw new ConnectionError("Query failed", { cause: pgError });
throw new ConnectionError("No response received from SQL Warehouse API");

Extends

• AppKitError

Constructors

Constructor

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

Parameters

Returns

ConnectionError

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: "CONNECTION_ERROR" = "CONNECTION_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: 503 = 503;

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

apiFailure()

static apiFailure(service: string, cause?: Error): ConnectionError;

Create a connection error for API failures

Parameters

Returns

ConnectionError

clientUnavailable()

static clientUnavailable(clientType: string, hint?: string): ConnectionError;

Create a connection error for client unavailable

Parameters

Returns

ConnectionError

poolError()

static poolError(operation: string, cause?: Error): ConnectionError;

Create a connection error for pool errors

Parameters

Returns

ConnectionError

queryFailed()

static queryFailed(cause?: Error): ConnectionError;

Create a connection error for query failure

Parameters

Returns

ConnectionError

transactionFailed()

static transactionFailed(cause?: Error): ConnectionError;

Create a connection error for transaction failure

Parameters

Returns

ConnectionError