orourkek / typesafe-ipc Goto Github PK

View Code? Open in Web Editor NEW

23.0 3.0 8.0 389 KB

A type-only library for adding strict typing to Electron's IPC modules

TypeScript 90.60% JavaScript 9.40%

electron electron-ipc ipc typescript typesafe type-safety strict-types

typesafe-ipc's People

Contributors

Stargazers

Watchers

Forkers

descriptinc gikkman jakoblaegdsmand psalaets vividlearningsystems yukikitagata clemintina

typesafe-ipc's Issues

Suggestion: Different send/listen definitions for main and renderer

I really like this library concept, and I fully agree with the outlined issue described in the philosophy part. But one thing I think would be a great enhancement would be to be able to define different events which ipcMain and ipcRenderer can send.

I saw that another typings library had that feature, so I forked this and tried to tinker it myself but my understanding of how to work with these types isn't enough.

Basically, I think it'd be helpful to do:

interface EventsFromMain {
  'msg-A': void;
}

interface EventsFromRenderer {
  'msg-B': void;
}

/* First generic indicates what types can be used for send methods, 
second generic indicates what can be used in listener methods */
const ipcRenderer: StrictIpcRenderer<EventsFromRenderer, EventsFromMain > = electron.ipcRenderer;
const ipcMain: StrictIpcMain<EventsFromMain, EventsFromRenderer> = electron.ipcMain;

Incorrect signature for `RemoveAllListeners`

The signature for the removeAllListeners method is incorrectly defined here in typesafe-ipc:

type RemoveAllListenersSignatures<
  ChannelMap extends StrictChannelMap
> = IntersectMethodSignatures<{
  [C in keyof ChannelMap]: (
    channel: C,
    listener: ChannelMap[C] extends void ?
      (event: electron.Event) => void :
      (event: electron.Event, payload: ChannelMap[C]) => void
  ) => void
}>;

Here's the actual signature as defined by electron:

interface IpcMain extends EventEmitter {
  // ...
  removeAllListeners(channel: string): this;
  // ...
}

Electron types outdated

Use interface augmnentation

@orourkek Please have a look at this lib: https://github.com/zardoy/typed-ipc.

I think it's more easy to use since it uses module augmentation.

For instance, we could rewrite your example in this way:

// ipc schema
declare module "typed-ipc" {
 interface IpcMainEvents {
  'no-payload': void;
  'simple-payload': string;
  'complex-payload': {
    foo: string;
    bar: {
      baz: number;
    }
  };
 }
}
// there is no need to export functions

And use it somewhere in main/renderer process:

// everything is type safe and matches the schema, that we declared above
// main
import { typedIpcMain } from "typed-ipc";

typedIpcMain.addEventListener("complex-payload", async (_event, { foo, bar }) => {
	// ...
});

// renderer
import { typedIpcRenderer } from "typed-ipc";

typedIpcRenderer.send("complex-payload", { foo: "str", bar: { baz: 5 } });

orourkek / typesafe-ipc Goto Github PK

typesafe-ipc's People

Contributors

Stargazers

Watchers

Forkers

typesafe-ipc's Issues

Suggestion: Different send/listen definitions for main and renderer

Incorrect signature for `RemoveAllListeners`

Electron types outdated

Use interface augmnentation

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent