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.