https://github.com/zardoy/typed-ipc
Designed for IPC usage in Electron
https://github.com/zardoy/typed-ipc
convenient electron ipc schema
Last synced: about 2 months ago
JSON representation
Designed for IPC usage in Electron
- Host: GitHub
- URL: https://github.com/zardoy/typed-ipc
- Owner: zardoy
- License: mit
- Created: 2021-02-14T22:59:11.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-06-09T18:06:22.000Z (about 5 years ago)
- Last Synced: 2026-01-29T10:13:00.922Z (4 months ago)
- Topics: convenient, electron, ipc, schema
- Language: TypeScript
- Homepage: https://npmjs.com/typed-ipc
- Size: 174 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# Typed IPC
**The most** convenient way to use IPC in electron.
> Still experimental
- [Typed IPC](#typed-ipc)
- [Why](#why)
- [Plans](#plans)
- [Usage](#usage)
- [How am I Using it](#how-am-i-using-it)
- [Why this?](#why-this)
## Why?
Because I love refactoring. What if I want to rename the listener or handler? With this module all you have to do is to press one button in VSCode: F2
## Usage
For usage, see [GUIDE.MD](./GUIDE.MD)
## Plans
- [ ] Guide how to use with preload script (we don't have access to event renderer modules from electron with contextIsolation: true which is default)
- [ ] REACT. Add lots of great hooks for more convenient work from react. I'm highly inspired by @apollo/client. That's why I call *variables* data that must be passed to event.
- [ ] VSCode extension :fire:
- [ ] Review guide style according to [Prisma](https://www.prisma.io/docs/about/style-guide)
## How am I Using it
Please have a look at my Electron apps:
- [Electron Tray Demo](https://github.com/zardoy/electron-tray-demo/search?q="typed-ipc")
- [FilmoMania](https://github.com/zardoy/filmomania-public/search?q="typed-ipc")
## Why this?
I already have looked at this alternatives:
- https://github.com/orourkek/typesafe-ipc
- https://github.com/deiucanta/electron-typed-ipc