electron-ipc-responder

A simple request/response based communication protocol for Electrons IPC functionality

Usage no npm install needed!

<script type="module">
  import electronIpcResponder from 'https://cdn.skypack.dev/electron-ipc-responder';
</script>

README

electron-ipc-responder

Build Status js-standard-style Commitizen friendly npm version semantic-release

electron-ipc-responder provides a Request-Response pattern-based communication using Electrons IPC module.

IPCResponder is used to set up the communication peers on Electrons main and renderer process. Once ready, registerTopic() can be used to make a specific function available to being called upon from the other peer. To do so, ask() and tell() is available. ask allows you to wait for a specific answer upon your request from the other peer. tell sends your message and does not wait for any reply ("fire and forget"). Both return a promise for the ease of use.

electron-ipc-responder is transpiled using Babel and available in pure ES5 via npm.

Please refer to the documentation for more details.

Installation

$ npm install electron-ipc-responder --save

License

Copyright (c) 2016 Manuel Alabor

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.