https://github.com/4i8/iipc
iipc is a simple Inter Process Communication for nodejs built on ws to communicate between processes safely and easily using tcp and websocket, You can also return data to the client see (example)
https://github.com/4i8/iipc
interprocess interprocess-communication ipc node-ipc tcp websocket ws
Last synced: 6 days ago
JSON representation
iipc is a simple Inter Process Communication for nodejs built on ws to communicate between processes safely and easily using tcp and websocket, You can also return data to the client see (example)
- Host: GitHub
- URL: https://github.com/4i8/iipc
- Owner: 4i8
- License: apache-2.0
- Created: 2023-04-23T10:19:31.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-04-23T10:19:37.000Z (about 2 years ago)
- Last Synced: 2024-08-11T08:32:51.487Z (9 months ago)
- Topics: interprocess, interprocess-communication, ipc, node-ipc, tcp, websocket, ws
- Language: JavaScript
- Homepage:
- Size: 37.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# **iipc**
**iipc is a simple Inter Process Communication for nodejs built on [ws](https://www.npmjs.com/package/ws) to communicate between processes safely and easily using tcp and websocket, You can also return data to the client see ([example](#example))**
# **Important:**
**this package is not biased and does not have any hidden features that can harm the user Fun use**
# **Installation**
# **Linux**
**Must install netstat**
```sh-session
sudo apt-get install net-tools
```
```sh-session
npm install iipc
yarn add iipc
```
# **Windows**
**Tested on Windows 10**
```sh-session
npm install iipc
yarn add iipc
```
# **MacOS**
**Not Tested on MacOS, but we hope it works if your device is a MacOS, please let us know if it works**
# Example
## index.js process 1
```js
const { ipc } = require("iipc");
const $ = new ipc("test"); // This is the secret that will be used to authenticate the client
$.on("listening", () => {
console.log("IPC IS ON! Enjoy");
});
//custom port use: new ipc(8080);
$.on("receive", ({ res, resolve }) => {
console.log(res); //Hello
resolve("Hi!"); // This is the data that will be sent back to the client
//if you don't use resolve, the client will wait forever and promise will never resolve
});
```
## client.js process 2
```js
const { client } = require("iipc");
client("test", "Hello").then((back) => {
console.log(back); //Hi!
});
//custom port use: client(8080, "Hello");
```
## Links
- [Twiter](https://twitter.com/onlyarth)
- [Github](https://github.com/4i8)
## License
- [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0)