https://github.com/kwonoj/comlink-electron-adapter
Comlink endpoint adapter for Electron's IPC
https://github.com/kwonoj/comlink-electron-adapter
Last synced: over 1 year ago
JSON representation
Comlink endpoint adapter for Electron's IPC
- Host: GitHub
- URL: https://github.com/kwonoj/comlink-electron-adapter
- Owner: kwonoj
- License: mit
- Created: 2019-05-26T22:04:39.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-03-30T23:17:35.000Z (over 6 years ago)
- Last Synced: 2025-04-23T00:12:17.296Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 220 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/kwonoj/comlink-electron-adapter)
[](https://ci.appveyor.com/project/kwonoj/comlink-electron-adapter/branch/master)
[](https://codecov.io/gh/kwonoj/comlink-electron-adapter)
[](https://www.npmjs.com/package/comlink-electron-adapter)
[](https://www.npmjs.com/package/comlink-electron-adapter)
# Comlink-electron-adapter
[Comlink](https://github.com/GoogleChromeLabs/comlink) provides way to interface between worker-like endpoint via ES proxy. This module allows to create custom endpoints around Electron's IPC (https://electronjs.org/docs/api/ipc-main) for proxy object across Electron's processes.
# Install
This has a peer dependencies of `comlink@4`, which will have to be installed as well
```sh
npm install comlink-electron-adapter
```
# Usage
There are separate endpoint creation method per object's origin.
## Expose main process's object to renderer project
```ts
// main process
import { ipcMain } from 'electron';
import { expose } from 'comlink';
import { mainProcObjectEndpoint } from 'comlink-electron-adapter';
const mainProcessObject = {...};
expose(mainProcessObject, mainProcObjectEndpoint(ipcMain));
// renderer process
import { wrap } from 'comlink';
import { ipcRenderer } from 'electron';
// `proxied` is proxy object to `mainProcessObject` in main process
const proxied = wrap(mainProcObjectEndpoint(ipcRenderer));
```
## Expose renderer process's object to main process
It is also possible to access renderer process's object in main process.
```ts
// renderer process
import { expose } from 'comlink';
import { ipcRenderer } from 'electron';
import { rendererProcObjectEndpoint } from 'comlink-electron-adapter';
const rendererProcessObject = {...};
expose(rendererProcessObject, rendererProcObjectEndpoint(ipcRenderer));
// main process
import { wrap } from 'comlink';
import { ipcMain } from 'electron';
import { rendererProcObjectEndpoint } from 'comlink-electron-adapter';
const rendererProcessWindow = new BrowserWindow();
rendererProcessWindow.loadFile('.../renderer.js');
const proxied = wrap(requestRendererProcessEndpoint(ipcMain, rendererProcessWindow.webContents));
```
Unlike renderer process main process does not aware target renderer process to send message and target webContents should be specified. Also main process should wait call proxy object until renderer process expose its object.
# Note
Due to Electron IPC's design `comlink-electron-adapter` do not support `transferable`. Using `Comlink.transfer` will raise not supported exception.
# Building / Testing
Few npm scripts are supported for build / test code.
- `build`: Transpiles code to ES5 commonjs to `dist`.
- `test`: Run test cases.
- `lint`: Run lint over all codebases
- `lint:staged`: Run lint only for staged changes. This'll be executed automatically with precommit hook.
- `commit`: Commit wizard to write commit message
# License
[MIT](https://github.com/kwonoj/comlink-electron-adapter/blob/master/LICENSE)