Skip to main content

Interface: StateSyncEventData

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

Payload for state synchronization events.

Remarks​

Used to notify frontend about state changes that occurred in the backend. Supports various sync actions including bulk updates, deletions, and individual updates.

Examples​

const event: StateSyncEventData = {
    action: "bulk-sync",
    sites: updatedSites,
    source: "database",
    timestamp: Date.now(),
};
const event: StateSyncEventData = {
    action: "delete",
    siteIdentifier: "site_123",
    sites: [],
    source: "database",
    timestamp: Date.now(),
};

Extends​

Properties​

timestamp​

readonly timestamp: number

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

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:76

Runtime metadata describing the emission context.

Inherited from​

BaseEventData._meta

_originalMeta?​

readonly optional _originalMeta: EventMetadata

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

Preserves previously attached metadata when re-emitting events.

Inherited from​

BaseEventData._originalMeta

action​

readonly action: "bulk-sync" | "delete" | "update"

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

The synchronization action being performed

delta?​

readonly optional delta: SiteSyncDelta

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

Structured delta describing how the site collection changed

siteIdentifier?​

readonly optional siteIdentifier: string

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

Site identifier for targeted operations (delete, update)

sites​

readonly sites: Site[]

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

Complete site dataset after the sync operation

source​

readonly source: "cache" | "database" | "frontend"

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

Source system that triggered the sync