Skip to main content

Class: InitializationError

Class: InitializationError

Error thrown when a service or component is not properly initialized. Use when accessing services before they are ready.

Example

throw new InitializationError("CacheManager not initialized");
throw new InitializationError("ServiceContext not initialized. Call ServiceContext.initialize() first.");

Extends

Constructors

Constructor

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

Parameters

ParameterType
messagestring
options?{ cause?: Error; clientMessage?: string; context?: Record<string, unknown>; }
options.cause?Error
options.clientMessage?string
options.context?Record<string, unknown>

Returns

InitializationError

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 messagemessage 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: "INITIALIZATION_ERROR" = "INITIALIZATION_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: 500 = 500;

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


migrationFailed()

static migrationFailed(cause?: Error): InitializationError;

Create an initialization error for migration failure

Parameters

ParameterType
cause?Error

Returns

InitializationError


notInitialized()

static notInitialized(serviceName: string, hint?: string): InitializationError;

Create an initialization error for a service that is not ready

Parameters

ParameterType
serviceNamestring
hint?string

Returns

InitializationError


setupFailed()

static setupFailed(component: string, cause?: Error): InitializationError;

Create an initialization error for setup failure

Parameters

ParameterType
componentstring
cause?Error

Returns

InitializationError

Databricks Developer Hub

Ready to ship your next agentic app in minutes?

Read docs