{"id":18563370,"url":"https://github.com/compulim/electron-ipcrenderer-messageport","last_synced_at":"2025-05-15T18:13:14.872Z","repository":{"id":82478850,"uuid":"133270053","full_name":"compulim/electron-ipcrenderer-messageport","owner":"compulim","description":"Turns Electron IPCRenderer into MessagePort","archived":false,"fork":false,"pushed_at":"2018-07-19T22:50:21.000Z","size":212,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-17T13:11:34.429Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/compulim.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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}},"created_at":"2018-05-13T20:00:37.000Z","updated_at":"2018-07-19T22:50:22.000Z","dependencies_parsed_at":null,"dependency_job_id":"a8986fb3-a476-46a1-ae41-cdb98260a00f","html_url":"https://github.com/compulim/electron-ipcrenderer-messageport","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compulim%2Felectron-ipcrenderer-messageport","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compulim%2Felectron-ipcrenderer-messageport/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compulim%2Felectron-ipcrenderer-messageport/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compulim%2Felectron-ipcrenderer-messageport/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/compulim","download_url":"https://codeload.github.com/compulim/electron-ipcrenderer-messageport/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254394726,"owners_count":22063984,"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":[],"created_at":"2024-11-06T22:12:26.775Z","updated_at":"2025-05-15T18:13:14.848Z","avatar_url":"https://github.com/compulim.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# electron-ipcrenderer-messageport\n\n[![npm version](https://badge.fury.io/js/electron-ipcrenderer-messageport.svg)](https://badge.fury.io/js/electron-ipcrenderer-messageport) [![Build Status](https://travis-ci.org/compulim/electron-ipcrenderer-messageport.svg?branch=master)](https://travis-ci.org/compulim/electron-ipcrenderer-messageport)\n\nTurns Electron [`IPCRenderer`](https://github.com/electron/electron/blob/master/docs/api/ipc-renderer.md) into [MessagePort](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort).\n\n# Background\n\nInstead of learning/using different API for different communication channels, we should unite them into a single interface pattern, either [MessagePort](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort) or [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket).\n\nThis package is expected to work in pair with [`electron-ipcmain-messageport`](https://npmjs.com/package/electron-ipcmain-messageport).\n\n# How to use\n\n```js\nconst IPCRendererMessagePort = require('electron-ipcrenderer-messageport');\nconst { ipcRenderer } = require('electron');\nconst messagePort = new IPCRendererMessagePort(ipcRenderer, 'channel_name');\n\nmessagePort.onmessage = event =\u003e {\n  // Could be either a string or Buffer\n  console.log(event.data);\n};\n\nmessagePort.postMessage('Hello, World!');\n```\n\nNote: to match the paradigm of MessagePort, we do not support synchronous messages and callbacks.\n\nIf you need to send to `\u003cwebview\u003e` instead of host (i.e. [`sendToHost`](https://electronjs.org/docs/api/ipc-renderer#ipcrenderersendtohostchannel-arg1-arg2-)), you can set `sendToHost` to `true`.\n\n```js\nconst messagePort = new IPCRendererMessagePort(ipcRenderer, 'channel_name', { sendToHost: true });\n```\n\n# Contributions\n\nLike us? [Star](https://github.com/compulim/electron-ipcrenderer-messageport/stargazers) us.\n\nWant to make it better? [File](https://github.com/compulim/electron-ipcrenderer-messageport/issues) us an issue.\n\nDon't like something you see? [Submit](https://github.com/compulim/electron-ipcrenderer-messageport/pulls) a pull request.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompulim%2Felectron-ipcrenderer-messageport","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcompulim%2Felectron-ipcrenderer-messageport","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompulim%2Felectron-ipcrenderer-messageport/lists"}