Skip to content

Type Alias: IPCMain ​

IPCMain = object

The part of Electron's ipcMain that electronIPCServiceEntrypoint uses (give a stand-in in the tests).

Methods ​

handle() ​

handle(channel, listener): void

Handle the invocations of a channel (ipcRenderer.invoke).

Parameters ​

channel ​

string

The IPC channel.

listener ​

(event, ...args) => unknown

Answers an invocation with its result.

Returns ​

void


on()? ​

optional on(channel, listener): unknown

Listen to the messages of a channel (ipcRenderer.send), used for the event subscriptions; without it, the pages are registered as clients only when they invoke with their id.

Parameters ​

channel ​

string

The IPC channel.

listener ​

(event, ...args) => void

Called with each message.

Returns ​

unknown


removeAllListeners()? ​

optional removeAllListeners(channel): unknown

Remove the listeners of a channel, when the adapter closes.

Parameters ​

channel ​

string

The IPC channel.

Returns ​

unknown


removeHandler() ​

removeHandler(channel): void

Remove the handler of a channel, when the adapter closes.

Parameters ​

channel ​

string

The IPC channel.

Returns ​

void

Released under the MIT License.