Skip to content

@statesync/electron


@statesync/electron / ElectronWebContentsLike

Interface: ElectronWebContentsLike

Defined in: types.ts:147

Structural type matching a subset of Electron's WebContents API used by the main-process broadcaster to send invalidation events to renderers.

Consumers can pass real webContents instances from BrowserWindow.webContents or any compatible mock/stub for testing.

Process context: main process only.

Example

ts
const targets: ElectronWebContentsLike[] = BrowserWindow.getAllWindows()
  .map(w => w.webContents);

Methods

isDestroyed()

ts
isDestroyed(): boolean;

Defined in: types.ts:154

Returns true if the underlying native web contents has been destroyed. Used as a guard before calling send to avoid runtime errors.

Returns

boolean

Whether the web contents instance has been destroyed.


send()

ts
send(channel, ...args): void;

Defined in: types.ts:163

Sends an asynchronous IPC message to the renderer process associated with this web contents instance.

Parameters

ParameterTypeDescription
channelstringThe IPC channel name.
...argsunknown[]Payload arguments to send along with the message.

Returns

void

Released under the MIT License.