Interface ElectronMessageEndpoint

Minimal ipcMain/ipcRenderer-style endpoint used by electronIpcTransport().

interface ElectronMessageEndpoint {
    off(
        channel: string,
        listener: (_event: unknown, message: RPCMessage) => void,
    ): void;
    on(
        channel: string,
        listener: (_event: unknown, message: RPCMessage) => void,
    ): void;
    send(channel: string, message: RPCMessage): void;
}

Index

Methods

off on send

Methods

off

off(
channel: string,
listener: (_event: unknown, message: RPCMessage) => void,
): void
Remove a listener from the named Electron IPC channel.
Parameters
- channel: string
- listener: (_event: unknown, message: RPCMessage) => void
Returns void
- Defined in packages/kkrpc/src/transports/electron.ts:22

on

on(
channel: string,
listener: (_event: unknown, message: RPCMessage) => void,
): void
Attach a listener for the named Electron IPC channel.
Parameters
- channel: string
- listener: (_event: unknown, message: RPCMessage) => void
Returns void
- Defined in packages/kkrpc/src/transports/electron.ts:20

send

send(channel: string, message: RPCMessage): void
Send one RPC message on the named Electron IPC channel.
Parameters
- channel: string
- message: RPCMessage
Returns void
- Defined in packages/kkrpc/src/transports/electron.ts:18

Interface ElectronMessageEndpoint

Index

Methods

Methods

off

Parameters

Returns void

on

Parameters

Returns void

send

Parameters

Returns void

Settings

On This Page