sindresorhus/electron-better-ipc

Better Typescript Support

Open

#45 创建于 2022年7月20日

在 GitHub 查看
 (5 评论) (0 反应) (0 负责人)JavaScript (744 star) (53 fork)user submission
enhancementhelp wanted

描述

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

贡献者指南

技术栈
typescriptelectron
领域
desktopdeveloper experience
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
TypeScript genericsElectron IPC basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
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.