Skip to main content

Interface: StateSyncServiceContract

Defined in: src/services/StateSyncService.ts:56

Contract for renderer-facing state synchronization operations.

Remarks​

Provides guarded access to preload-managed IPC endpoints so callers do not touch the window.electronAPI global directly. Implementations must ensure the Electron bridge is ready before invoking any underlying channel.

Properties​

getSyncStatus()​

readonly getSyncStatus: () => Promise<{ lastSyncAt?: number | null; siteCount: number; source: "cache" | "database" | "frontend"; synchronized: boolean; }>

Defined in: src/services/StateSyncService.ts:58

Retrieves the latest synchronization status snapshot from the backend.

Returns​

Promise<{ lastSyncAt?: number | null; siteCount: number; source: "cache" | "database" | "frontend"; synchronized: boolean; }>

initialize()​

readonly initialize: () => Promise<void>

Defined in: src/services/StateSyncService.ts:60

Ensures the preload bridge is available prior to IPC usage.

Returns​

Promise<void>

onStateSyncEvent()​

readonly onStateSyncEvent: (callback: (event: StateSyncEventData) => void) => Promise<() => void>

Defined in: src/services/StateSyncService.ts:65

Registers a handler for incremental state sync events and returns a cleanup callback.

Parameters​

callback​

(event: StateSyncEventData) => void

Returns​

Promise<() => void>

requestFullSync()​

readonly requestFullSync: () => Promise<{ completedAt: number; siteCount: number; sites: Site[]; source: "cache" | "database" | "frontend"; synchronized: boolean; }>

Defined in: src/services/StateSyncService.ts:72

Requests a full synchronization cycle and returns the backend result payload.

Returns​

Promise<{ completedAt: number; siteCount: number; sites: Site[]; source: "cache" | "database" | "frontend"; synchronized: boolean; }>