Skip to main content

Interface: DatabaseConnectionEventData

Defined in: shared/types/events.ts:464

Payload for database connection events.

Remarks​

Used to track database connection state changes. Important for monitoring database availability and connection health.

Example​

const event: DatabaseConnectionEventData = {
    state: "connected",
    connectionId: "conn_123",
};

Hierarchy​

View Summary

Extends​

Indexable​

[key: string]: unknown
[key: number]: unknown
[key: symbol]: unknown

Properties​

timestamp​

readonly timestamp: number;

Defined in: shared/types/events.ts:104

The time (in milliseconds since epoch) when the event occurred.

Inherited from​

BaseEventData.timestamp

_meta?​

readonly optional _meta?: EventMetadata;

Defined in: shared/types/events.ts:106

Runtime metadata describing the emission context.

Inherited from​

BaseStateSyncEventData._meta

_originalMeta?​

readonly optional _originalMeta?: EventMetadata;

Defined in: shared/types/events.ts:108

Preserves previously attached metadata when re-emitting events.

Inherited from​

BaseStateSyncEventData._originalMeta

connectionId?​

optional connectionId?: string;

Defined in: shared/types/events.ts:466

Unique identifier for the connection

details?​

optional details?: string;

Defined in: shared/types/events.ts:468

Additional context about the connection state

state​

state: "error" | "connected" | "connecting" | "disconnected";

Defined in: shared/types/events.ts:470

Current connection state