Skip to content

@statesync/electron


@statesync/electron / createElectronInvalidationSubscriber

Function: createElectronInvalidationSubscriber()

ts
function createElectronInvalidationSubscriber(options): InvalidationSubscriber;

Defined in: transport.ts:64

Creates an InvalidationSubscriber that listens for invalidation events over Electron IPC.

This transport is intentionally thin — it simply forwards raw IPC payloads as InvalidationEvent objects. The core engine is responsible for validating topic and revision at runtime.

Mirrors createTauriInvalidationSubscriber in the @statesync/tauri package.

Process context: renderer process.

Parameters

ParameterTypeDescription
optionsElectronInvalidationSubscriberOptionsConfiguration specifying the listen function and IPC channel.

Returns

InvalidationSubscriber

An InvalidationSubscriber compatible with the core engine's RevisionSyncOptions.subscriber option.

Example

ts
const subscriber = createElectronInvalidationSubscriber({
  listen: bridge.on,
  channel: 'statesync:todos:invalidated',
});

Released under the MIT License.