sindresorhus/electron-better-ipc

Better Typescript Support

Open

#45 aberto em 20 de jul. de 2022

Ver no 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

Guia do colaborador

Pilha de tecnologia
typescriptelectron
Domain
desktopdeveloper experience
Tipo Issue
feature
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 days
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
TypeScript genericsElectron IPC basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40
Direção de pesquisa
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.