https://github.com/mariotacke/redux-electron-ipc
Redux Electron IPC Middleware
https://github.com/mariotacke/redux-electron-ipc
electron event ipc javascript middleware redux
Last synced: 3 months ago
JSON representation
Redux Electron IPC Middleware
- Host: GitHub
- URL: https://github.com/mariotacke/redux-electron-ipc
- Owner: mariotacke
- License: mit
- Created: 2016-05-31T23:27:38.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-11-27T23:28:13.000Z (almost 7 years ago)
- Last Synced: 2025-06-07T20:07:46.844Z (4 months ago)
- Topics: electron, event, ipc, javascript, middleware, redux
- Language: JavaScript
- Size: 103 KB
- Stars: 55
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Redux Electron IPC Middleware
[](https://travis-ci.org/mariotacke/redux-electron-ipc) [](https://badge.fury.io/js/redux-electron-ipc) [](https://coveralls.io/github/mariotacke/redux-electron-ipc?branch=master) [](https://raw.githubusercontent.com/mariotacke/redux-electron-ipc/master/LICENSE)
A [Redux](https://github.com/reactjs/redux) middleware to reduce code around ipc
calls in an [Electron](http://electron.atom.io/) application. You can send and
receive [IPC](https://github.com/electron/electron/blob/master/docs/api/ipc-main.md)
events with a simple api.
## Install
### [npm](https://www.npmjs.com/package/redux-electron-ipc)
```sh
npm install --save redux-electron-ipc
```
## Usage
Check out the full [demo](https://github.com/mariotacke/redux-electron-ipc/tree/master/example)
application.
### Window
```js
import { applyMiddleware, createStore } from 'redux';
import createIpc, { send } from 'redux-electron-ipc';
import { pongActionCreator } from './actions';
import { exampleReducer } from './reducer';
// register an action creator to an ipc channel (key/channel, value/action creator)
const ipc = createIpc({
'pong': pongActionCreator, // receive a message
...
});
const store = createStore(exampleReducer, applyMiddleware(ipc));
// send a message with arguments through the `send` utility function
store.dispatch(send('ping', 'redux', 'electron', 'ipc'));
```
### Main
```js
// your regular ipc setup
const electron = require('electron');
const { ipcMain } = electron;
...
// pong event with arguments back to caller
ipcMain.on('ping', (event, ...args) => {
console.log('Ping', ...args);
event.sender.send('pong', ...args);
});
```
## API
`redux-electron-ipc` has a default constructor function for creating ipc
middleware, and a named `send` utility function.
```js
createIpc(events?: Object) => IpcMiddleware
send(channel: string, ...arg1?: Object, arg2?: Object, ..., argN?:Object) => Action
```
### Events
Each key on the `events` object (default: `{}`) registers a single ipc channel
response. The key designates the `ipc` channel; the value is a redux action
creator to be dispatched.
```js
{
'ipc channel name': (event, ...args) => {
return {
type: 'YOUR_ACTION_TYPE',
... optional mapping of arguments ...
}
}
}
```
### Examples
#### Sending an IPC event
Use the utility function `send` to issue an ipc message to the main thread. The
method signature is the same as ipcRenderer's send.
Behind the scenes, the ipc middleware will trigger the ipc on the given channel
with any number of arguments.
```js
import { send } from 'redux-electron-ipc';
store.dispatch(send('ipc event channel', ...args));
```
#### Receiving an IPC event
To receive events, register a channel response when configuring the middleware.
```js
const ipc = createIpc({
'channel to listen to': () => {
return {
type: 'IPC_RESPONSE_ACTION',
... optional mapping of arguments ...
}
}
...
});
const store = createStore(exampleReducer, applyMiddleware(ipc));
```
## What about `redux-thunk`?
`redux-electron-ipc` supports thunks out of the box as long as you install `redux-thunk` and apply the thunk middleware before the ipc middleware.
### Example
```js
const ipc = createIpc({
'ipc channel name': () => dispatch =>
dispatch({ type: 'DELAYED_ACTION_TYPE' })
});
const store = createStore(exampleReducer, applyMiddleware(thunk, ipc));
```
## Questions
For any questions, please open an [issue](https://github.com/mariotacke/redux-electron-ipc/issues).
Pull requests (with tests) are appreciated.