sindresorhus/electron-better-ipc

Better Typescript Support

Open

#45 opened on Jul 20, 2022

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (744 stars) (53 forks)user submission
enhancementhelp wanted

Description

It'd be lovely if this library came with excellent Typescript support, where one can define which "ipc methods" actually exist. Like being able to say

type MainIpc = {
  "get-emoji"(name: string): string;
};

Then doing a bit to annotate the IPC with said types, like const ipc: SafeMainProcessIpc<MainIpc, RendererIpc> = ipcMain;

After that, one could have excellent autocomplete and Typescript errors if something doesn't add up. image

Contributor guide

Tech stack
typescriptelectron
Domain
desktopdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript genericsElectron IPC basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the current IPC implementation in the library (e.g., src/index.js) to understand how ipcMain and ipcRenderer are used. Design TypeScript types that allow users to define a schema for IPC methods, using generics and conditional types for type safety. Check existing comments in the issue for any prior attempts or preferences from the maintainer. Consider creating a new types.ts file with the necessary type definitions and updating the package.json to include TypeScript support.