{"id":20161031,"url":"https://github.com/delight-rpc/electron","last_synced_at":"2025-10-10T03:03:15.317Z","repository":{"id":44838501,"uuid":"427594036","full_name":"delight-rpc/electron","owner":"delight-rpc","description":"🌲","archived":false,"fork":false,"pushed_at":"2025-02-07T03:54:48.000Z","size":1321,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-21T12:41:44.110Z","etag":null,"topics":["electron","esm","library","npm-package","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@delight-rpc/electron","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/delight-rpc.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-11-13T07:06:22.000Z","updated_at":"2025-06-17T13:45:17.000Z","dependencies_parsed_at":"2025-01-13T13:46:45.073Z","dependency_job_id":"260dc549-77dc-4369-bd24-980f80095852","html_url":"https://github.com/delight-rpc/electron","commit_stats":{"total_commits":75,"total_committers":2,"mean_commits":37.5,"dds":0.12,"last_synced_commit":"cf0069cf7ba5f58d5d827ed19da246ad477f593c"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"purl":"pkg:github/delight-rpc/electron","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delight-rpc%2Felectron","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delight-rpc%2Felectron/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delight-rpc%2Felectron/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delight-rpc%2Felectron/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/delight-rpc","download_url":"https://codeload.github.com/delight-rpc/electron/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delight-rpc%2Felectron/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279002477,"owners_count":26083405,"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","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","esm","library","npm-package","typescript"],"created_at":"2024-11-14T00:16:59.998Z","updated_at":"2025-10-10T03:03:15.299Z","avatar_url":"https://github.com/delight-rpc.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @delight-rpc/electron\n## Install\n```sh\nnpm install --save @delight-rpc/electron\n# or\nyarn add @delight-rpc/electron\n```\n\n## Usage\nIf your application sends RPC requests immediately after creating the RPC client,\nyou need to create the RPC server as soon as possible,\nwhich means your corresponding code needs to be as **synchronized** as possible.\n\n### Main as Client, Renderer as Server\n#### api.d.ts\n```ts\ninterface IAPI {\n  echo(message: string): string\n}\n```\n\n#### main.js\n```ts\nimport { app, ipcMain } from 'electron'\nimport { createClientInMain } from '@delight-rpc/electron'\n\nawait app.whenReady()\n\nipcMain.on('message-port', async event =\u003e {\n  const [port] = event.ports\n\n  port.start()\n  const [client] = createClientInMain\u003cIAPI\u003e(port)\n  await client.echo('hello world')\n})\n\nconst window = new BrowserWindow({\n  webPreferences: { preload: 'preload.js' }\n})\nwindow.loadFile('renderer.html')\n```\n\n#### preload.js\n```ts\nimport { ipcRenderer } from 'electron'\n\nwindow.addEventListener('message', event =\u003e {\n  if (event.data === 'message-port') {\n    const [port] = event.ports\n    ipcRenderer.postMessage('message-port', null, [port])\n  }\n})\n```\n\n#### renderer.js\n```ts\nimport { createServerInRenderer } from '@delight-rpc/electron'\n\nconst api: IAPI = {\n  echo(message) {\n    return message\n  }\n}\n\n// create the MessageChannel in the renderer,\n// because its script file is always executed last.\nconst channel = new MessageChannel()\n\nchannel.port1.start()\ncreateServerInRenderer(api, channel.port1)\nwindow.postMessage('message-port', '*', [channel.port2])\n```\n\n### Renderer as Client, Main as Server\n#### api.d.ts\n```ts\ninterface IAPI {\n  echo(message: string): string\n}\n```\n\n#### main.js\n```ts\nimport { app, ipcMain } from 'electron'\nimport { createClientInMain } from '@delight-rpc/electron'\n\nconst api: IAPI = {\n  echo(message) {\n    return message\n  }\n}\n\nawait app.whenReady()\n\nipcMain.on('message-port', event =\u003e {\n  const [port] = event.ports\n\n  port.start()\n  createServerInMain(api, port)\n})\n\nconst window = new BrowserWindow({\n  webPreferences: { preload: 'preload.js' }\n})\nwindow.loadFile('renderer.html')\n```\n\n#### preload.js\n```ts\nimport { ipcRenderer } from 'electron'\n\nwindow.addEventListener('message', event =\u003e {\n  if (event.data === 'message-port') {\n    const [port] = event.ports\n    ipcRenderer.postMessage('message-port', null, [port])\n  }\n})\n```\n\n#### renderer.js\n```ts\nimport { createClientInRenderer } from '@delight-rpc/electron'\n\n// create the MessageChannel in the renderer,\n// because its script file is always executed last.\nconst channel = new MessageChannel()\nwindow.postMessage('message-port', '*', [channel.port2])\n\nchannel.port1.start()\nconst [client] = createClientInRenderer(api, channel.port1)\nawait client.echo('hello world')\n```\n\n### Renderer as Client, Renderer as Server\n#### api.d.ts\n```ts\ninterface IAPI {\n  echo(message: string): string\n}\n```\n\n#### main.js\n```ts\nimport { app, ipcMain, MessageChannelMain } from 'electron'\n\nawait app.whenReady()\n\nconst windowA = new BrowserWindow({\n  webPreferences: { preload: 'preload.js' }\n})\nwindowA.loadFile('renderer-a.html')\n\nconst windowB = new BrowserWindow({\n  webPreferences: { preload: 'preload.js' }\n})\nwindowB.loadFile('renderer-b.html')\n\nconst channel = new MessageChannelMain()\nwindowA.webContents.postMessage('message-port', null, [channel.port1])\nwindowB.webContents.postMessage('message-port', null, [channel.port2])\n```\n\n#### preload.ts\n```ts\nimport { ipcRenderer, contextBridge } from 'electron'\nimport { Deferred } from 'extra-promise'\n\nconst ready = new Deferred\u003cvoid\u003e()\ncontextBridge.exposeInMainWorld('ready', () =\u003e {\n  ready.resolve()\n})\n\nipcRenderer.on('message-port', event =\u003e {\n  const [port] = event.ports\n  await ready\n  window.postMessage('message-port', '*', [port])\n})\n```\n\n#### renderer-a.js\n```ts\nimport { createServerInRenderer } from '@delight-rpc/electron'\n\nconst api: IAPI = {\n  echo(message) {\n    return message\n  }\n}\n\nwindow.addEventListener('message', async event =\u003e {\n  if (event.data === 'message-port') {\n    const [port] = event.ports\n\n    port.start()\n    createServerInRenderer(api, port)\n  }\n})\n\nwindow.ready()\n```\n\n#### renderer-b.js\n```ts\nimport { createClientInRenderer } from '@delight-rpc/electron'\n\nwindow.addEventListener('message', async event =\u003e {\n  if (event.data === 'message-port') {\n    const [port] = event.ports\n\n    port.start()\n    const [client] = createClientInRenderer\u003cIAPI\u003e(port)\n    await client.echo('hello world')\n  }\n})\n\nwindow.ready()\n```\n\n## API\n### createClientInMain\n```ts\nfunction createClientInMain\u003cIAPI extends object\u003e(\n  port: Electron.MessagePortMain\n, options?: {\n    parameterValidators?: DelightRPC.ParameterValidators\u003cIAPI\u003e\n    expectedVersion?: string\n    channel?: string\n  }\n): [client: DelightRPC.ClientProxy\u003cIAPI\u003e, close: () =\u003e void]\n```\n\n### createClientInRenderer\n```ts\nfunction createClientInRenderer\u003cIAPI extends object\u003e(\n  port: MessagePort\n, options?: {\n    parameterValidators?: DelightRPC.ParameterValidators\u003cIAPI\u003e\n    expectedVersion?: string\n    channel?: string\n  }\n): [client: DelightRPC.ClientProxy\u003cIAPI\u003e, close: () =\u003e void]\n```\n\n### createBatchClientInMain\n```ts\nfunction createBatchClientInMain\u003cDataType\u003e(\n  port: Electron.MessagePortMain\n, options?: {\n    expectedVersion?: string\n    channel?: string\n  }\n): [client: DelightRPC.BatchClient\u003cDataType\u003e, close: () =\u003e void]\n```\n\n### createBatchClientInRenderer\n```ts\nfunction createBatchClientInRenderer\u003cDataType\u003e(\n  port: MessagePort\n, options?: {\n    expectedVersion?: string\n    channel?: string\n  }\n): [client: DelightRPC.BatchClient\u003cDataType\u003e, close: () =\u003e void]\n```\n\n### createServerInMain\n```ts\nfunction createServerInMain\u003cIAPI extends object\u003e(\n  api: DelightRPC.ImplementationOf\u003cIAPI\u003e\n, options?: {\n    port: Electron.MessagePortMain\n    parameterValidators?: DelightRPC.ParameterValidators\u003cIAPI\u003e\n    version?: `${number}.${number}.${number}`\n    channel?: string | RegExp | AnyChannel\n    ownPropsOnly?: boolean\n  }\n): () =\u003e void\n```\n\n### createServerInRenderer\n```ts\nfunction createServerInRenderer\u003cIAPI extends object\u003e(\n  api: DelightRPC.ImplementationOf\u003cIAPI\u003e\n, port: MessagePort\n, options?: {\n    parameterValidators?: DelightRPC.ParameterValidators\u003cIAPI\u003e\n    version?: `${number}.${number}.${number}`\n    channel?: string | RegExp | AnyChannel\n    ownPropsOnly?: boolean\n  }\n): () =\u003e void\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdelight-rpc%2Felectron","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdelight-rpc%2Felectron","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdelight-rpc%2Felectron/lists"}