{"id":14978538,"url":"https://github.com/el3um4s/ipc-for-electron","last_synced_at":"2025-08-02T16:39:11.564Z","repository":{"id":57747715,"uuid":"523300378","full_name":"el3um4s/ipc-for-electron","owner":"el3um4s","description":"A package to simplify the communication between renderer and node js in Electron applications","archived":false,"fork":false,"pushed_at":"2023-02-04T15:30:04.000Z","size":1616,"stargazers_count":2,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-29T01:43:22.050Z","etag":null,"topics":["electron","electronjs","inter-process-communication","ipc","node","nodejs","npm","renderer","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/el3um4s.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["el3um4s"],"patreon":"el3um4s","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://www.paypal.me/el3um4s"]}},"created_at":"2022-08-10T10:33:35.000Z","updated_at":"2023-03-15T13:51:56.000Z","dependencies_parsed_at":"2023-02-18T17:30:45.052Z","dependency_job_id":null,"html_url":"https://github.com/el3um4s/ipc-for-electron","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":"el3um4s/typescript-npm-package-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/el3um4s%2Fipc-for-electron","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/el3um4s%2Fipc-for-electron/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/el3um4s%2Fipc-for-electron/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/el3um4s%2Fipc-for-electron/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/el3um4s","download_url":"https://codeload.github.com/el3um4s/ipc-for-electron/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247248271,"owners_count":20908116,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["electron","electronjs","inter-process-communication","ipc","node","nodejs","npm","renderer","typescript"],"created_at":"2024-09-24T13:57:52.240Z","updated_at":"2025-04-04T20:33:38.314Z","avatar_url":"https://github.com/el3um4s.png","language":"TypeScript","funding_links":["https://github.com/sponsors/el3um4s","https://patreon.com/el3um4s","https://www.paypal.me/el3um4s"],"categories":[],"sub_categories":[],"readme":"# IPC for Electron\n\nA package to simplify the communication between renderer and node js in Electron applications\n\nNPM link: [@el3um4s/ipc-for-electron](https://www.npmjs.com/package/@el3um4s/ipc-for-electron)\n\n### Install and use the package\n\nTo use the package in a project:\n\n```bash\nnpm i @el3um4s/ipc-for-electron\n```\n\nand then in a file:\n\n```ts\nimport { IPC, generateContextBridge } from \"@el3um4s/ipc-for-electron\";\n```\n\n### How to add a new API\n\nUse IPC to create a new API for the renderer process:\n\n```ts\nimport { IPC, SendChannels } from \"@el3um4s/ipc-for-electron\";\nimport { BrowserWindow } from \"electron\";\n\nconst nameAPI = \"helloWorld\";\n\n// to Main\nconst validSendChannel: SendChannels = {\n  requestHello: requestHello,\n};\n\n// from Main\nconst validReceiveChannel: string[] = [\"getHello\"];\n\nconst systemInfo = new IPC({\n  nameAPI,\n  validSendChannel,\n  validReceiveChannel,\n});\n\nexport default helloWorld;\n\n// Enter here the functions for ElectronJS\n\nfunction requestHello(\n  mainWindow: BrowserWindow,\n  event: Electron.IpcMainEvent,\n  message: any\n) {\n  const result = {\n    name: \"John\",\n    message: \"Hello\",\n  };\n  mainWindow.webContents.send(\"getHello\", result);\n}\n```\n\n### Add the API to the context bridge\n\nAdd the api to the context bridge to use it in the renderer process. In the `preload.ts` file:\n\n```ts\nimport { generateContextBridge } from \"@el3um4s/ipc-for-electron\";\nimport helloWorld from \"./helloWorld\";\n\nconst listAPI = [helloWorld];\n\ngenerateContextBridge(listAPI, \"ipc\");\n```\n\n### Use the API from the renderer\n\nIn the renderer process, use the API:\n\n```ts\nglobalThis.ipc.helloWorld.send(\"requestHello\", null);\n\nglobalThis.ipc.helloWorld.receive(\"getHello\", async (data) =\u003e {\n  const { name, message } = data;\n  console.log(message, name);\n  //   Hello John\n});\n```\n\n### API Prebuilt\n\n**System Info**: _Allow the renderer to get information about the version of Electron, Chrome and NodeJS_\n\n- GitHub: [el3um4s/ipc-for-electron-system-info](https://github.com/el3um4s/ipc-for-electron-system-info) - [el3um4s/renderer-for-electron-system-info](https://github.com/el3um4s/renderer-for-electron-system-info)\n- NPM: [@el3um4s/ipc-for-electron-system-info](https://www.npmjs.com/package/@el3um4s/ipc-for-electron-system-info) - [@el3um4s/renderer-for-electron-system-info](https://www.npmjs.com/package/@el3um4s/renderer-for-electron-system-info)\n\n**Window Controls**: _Allow the renderer to close, minimize and maximize the window_\n\n- GitHub: [el3um4s/ipc-for-electron-window-controls](https://github.com/el3um4s/ipc-for-electron-window-controls) - [el3um4s/renderer-for-electron-window-controls](https://github.com/el3um4s/renderer-for-electron-window-controls)\n- NPM: [@el3um4s/ipc-for-electron-window-controls](https://www.npmjs.com/package/@el3um4s/ipc-for-electron-window-controls) - [@el3um4s/renderer-for-electron-window-controls](https://www.npmjs.com/package/@el3um4s/renderer-for-electron-window-controls)\n\n**Chokidar**: _Allow the renderer to use [chokidar](https://www.npmjs.com/package/chokidar) (Minimal and efficient cross-platform file watching library)_\n\n- GitHub: [el3um4s/ipc-for-electron-chokidar](https://github.com/el3um4s/ipc-for-electron-chokidar) - [el3um4s/renderer-for-electron-chokidar](https://github.com/el3um4s/renderer-for-electron-chokidar)\n- NPM: [@el3um4s/ipc-for-electron-chokidar](https://www.npmjs.com/package/@el3um4s/ipc-for-electron-chokidar) - [@el3um4s/renderer-for-electron-chokidar](https://www.npmjs.com/package/@el3um4s/renderer-for-electron-chokidar)\n\n**Auto Updater**: _Allow the renderer to update electron apps via [electron-updater](https://www.npmjs.com/package/electron-updater)_\n\n- GitHub: [el3um4s/ipc-for-electron-auto-updater](https://github.com/el3um4s/ipc-for-electron-auto-updater) - [el3um4s/renderer-for-electron-auto-updater](https://github.com/el3um4s/renderer-for-electron-auto-updater)\n- NPM: [@el3um4s/ipc-for-electron-auto-updater](https://www.npmjs.com/package/@el3um4s/ipc-for-electron-auto-updater) - [@el3um4s/renderer-for-electron-auto-updater](https://www.npmjs.com/package/@el3um4s/renderer-for-electron-auto-updater)\n  **Auto Updater**: _Allow the renderer to update electron apps via [electron-updater](https://www.npmjs.com/package/electron-updater)_\n\n**Electron Window**: _Create a window with optional autoupdater and browserview_\n\n- GitHub: [el3um4s/electron-window](https://github.com/el3um4s/electron-window) - [el3um4s/renderer-electron-window-browser-view](https://github.com/el3um4s/renderer-electron-window-browser-view)\n- NPM: [@el3um4s/electron-window](https://www.npmjs.com/package/@el3um4s/electron-window) - [@el3um4s/renderer-electron-window-browser-view](https://www.npmjs.com/package/@el3um4s/renderer-electron-window-browser-view)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fel3um4s%2Fipc-for-electron","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fel3um4s%2Fipc-for-electron","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fel3um4s%2Fipc-for-electron/lists"}