https://github.com/compulim/electron-ipcrenderer-messageport
Turns Electron IPCRenderer into MessagePort
https://github.com/compulim/electron-ipcrenderer-messageport
Last synced: about 1 year ago
JSON representation
Turns Electron IPCRenderer into MessagePort
- Host: GitHub
- URL: https://github.com/compulim/electron-ipcrenderer-messageport
- Owner: compulim
- Created: 2018-05-13T20:00:37.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-19T22:50:21.000Z (about 8 years ago)
- Last Synced: 2025-02-17T13:11:34.429Z (over 1 year ago)
- Language: JavaScript
- Size: 207 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# electron-ipcrenderer-messageport
[](https://badge.fury.io/js/electron-ipcrenderer-messageport) [](https://travis-ci.org/compulim/electron-ipcrenderer-messageport)
Turns Electron [`IPCRenderer`](https://github.com/electron/electron/blob/master/docs/api/ipc-renderer.md) into [MessagePort](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort).
# Background
Instead of learning/using different API for different communication channels, we should unite them into a single interface pattern, either [MessagePort](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort) or [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket).
This package is expected to work in pair with [`electron-ipcmain-messageport`](https://npmjs.com/package/electron-ipcmain-messageport).
# How to use
```js
const IPCRendererMessagePort = require('electron-ipcrenderer-messageport');
const { ipcRenderer } = require('electron');
const messagePort = new IPCRendererMessagePort(ipcRenderer, 'channel_name');
messagePort.onmessage = event => {
// Could be either a string or Buffer
console.log(event.data);
};
messagePort.postMessage('Hello, World!');
```
Note: to match the paradigm of MessagePort, we do not support synchronous messages and callbacks.
If you need to send to `` instead of host (i.e. [`sendToHost`](https://electronjs.org/docs/api/ipc-renderer#ipcrenderersendtohostchannel-arg1-arg2-)), you can set `sendToHost` to `true`.
```js
const messagePort = new IPCRendererMessagePort(ipcRenderer, 'channel_name', { sendToHost: true });
```
# Contributions
Like us? [Star](https://github.com/compulim/electron-ipcrenderer-messageport/stargazers) us.
Want to make it better? [File](https://github.com/compulim/electron-ipcrenderer-messageport/issues) us an issue.
Don't like something you see? [Submit](https://github.com/compulim/electron-ipcrenderer-messageport/pulls) a pull request.