Skip to main content

Interface: EventsDomainBridge

Defined in: shared/types/eventsBridge.ts:32

Contract for the preload events bridge exposed to the renderer.

Propertiesโ€‹

onCacheInvalidatedโ€‹

readonly onCacheInvalidated: (callback: (data: CacheInvalidatedEventData) => void) => () => void;

Defined in: shared/types/eventsBridge.ts:41

Subscribe to events emitted on the cache:invalidated channel.

Parametersโ€‹

callbackโ€‹

(data: CacheInvalidatedEventData) => void

Invoked with payloads emitted on the cache:invalidated channel.

Returnsโ€‹

Cleanup function that removes the registered listener.

() => void


onHistoryLimitUpdatedโ€‹

readonly onHistoryLimitUpdated: (callback: (data: HistoryLimitUpdatedEventData) => void) => () => void;

Defined in: shared/types/eventsBridge.ts:54

Subscribe to events emitted on the settings:history-limit-updated channel.

Parametersโ€‹

callbackโ€‹

(data: HistoryLimitUpdatedEventData) => void

Invoked with payloads emitted on the settings:history-limit-updated channel.

Returnsโ€‹

Cleanup function that removes the registered listener.

() => void


onMonitorCheckCompletedโ€‹

readonly onMonitorCheckCompleted: (callback: (data: MonitorCheckCompletedEventData) => void) => () => void;

Defined in: shared/types/eventsBridge.ts:66

Subscribe to events emitted on the monitor:check-completed channel.

Parametersโ€‹

callbackโ€‹

(data: MonitorCheckCompletedEventData) => void

Invoked with payloads emitted on the monitor:check-completed channel.

Returnsโ€‹

Cleanup function that removes the registered listener.

() => void


onMonitoringStartedโ€‹

readonly onMonitoringStarted: (callback: (data: MonitoringStartedEventData) => void) => () => void;

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

Subscribe to events emitted on the monitoring:started channel.

Parametersโ€‹

callbackโ€‹

(data: MonitoringStartedEventData) => void

Invoked with payloads emitted on the monitoring:started channel.

Returnsโ€‹

Cleanup function that removes the registered listener.

() => void


onMonitoringStoppedโ€‹

readonly onMonitoringStopped: (callback: (data: MonitoringStoppedEventData) => void) => () => void;

Defined in: shared/types/eventsBridge.ts:90

Subscribe to events emitted on the monitoring:stopped channel.

Parametersโ€‹

callbackโ€‹

(data: MonitoringStoppedEventData) => void

Invoked with payloads emitted on the monitoring:stopped channel.

Returnsโ€‹

Cleanup function that removes the registered listener.

() => void


onMonitorStatusChangedโ€‹

readonly onMonitorStatusChanged: (callback: (data: StatusUpdate) => void) => () => void;

Defined in: shared/types/eventsBridge.ts:102

Subscribe to events emitted on the monitor:status-changed channel.

Parametersโ€‹

callbackโ€‹

(data: StatusUpdate) => void

Invoked with payloads emitted on the monitor:status-changed channel.

Returnsโ€‹

Cleanup function that removes the registered listener.

() => void


onStateSyncEventโ€‹

readonly onStateSyncEvent: (callback: (data: StateSyncEventData) => void) => () => void;

Defined in: shared/types/eventsBridge.ts:114

Subscribe to events emitted on the state-sync-event channel.

Parametersโ€‹

callbackโ€‹

(data: StateSyncEventData) => void

Invoked with payloads emitted on the state-sync-event channel.

Returnsโ€‹

Cleanup function that removes the registered listener.

() => void


onUpdateStatusโ€‹

readonly onUpdateStatus: (callback: (data: UpdateStatusEventData) => void) => () => void;

Defined in: shared/types/eventsBridge.ts:126

Subscribe to events emitted on the update-status channel.

Parametersโ€‹

callbackโ€‹

(data: UpdateStatusEventData) => void

Invoked with payloads emitted on the update-status channel.

Returnsโ€‹

Cleanup function that removes the registered listener.

() => void


removeAllListenersโ€‹

readonly removeAllListeners: (channel?: keyof RendererEventPayloadMap) => void;

Defined in: shared/types/eventsBridge.ts:136

Remove registered renderer event listeners.

Parametersโ€‹

channel?โ€‹

keyof RendererEventPayloadMap

Optional channel to clear. Omitting it clears every renderer event listener.

Returnsโ€‹

void