{"id":17715644,"url":"https://github.com/jmjuanes/electron-channel","last_synced_at":"2026-04-29T18:32:06.083Z","repository":{"id":57221589,"uuid":"87948607","full_name":"jmjuanes/electron-channel","owner":"jmjuanes","description":"A dead simple ipc wrapper for electron","archived":false,"fork":false,"pushed_at":"2017-09-27T14:35:29.000Z","size":6,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-29T05:16:08.225Z","etag":null,"topics":["channel","electron","electron-ipc","electron-plugin","events","ipc"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/electron-channel","language":"JavaScript","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/jmjuanes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-04-11T15:11:44.000Z","updated_at":"2017-12-11T17:21:26.000Z","dependencies_parsed_at":"2022-08-29T01:50:45.994Z","dependency_job_id":null,"html_url":"https://github.com/jmjuanes/electron-channel","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/jmjuanes/electron-channel","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmjuanes%2Felectron-channel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmjuanes%2Felectron-channel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmjuanes%2Felectron-channel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmjuanes%2Felectron-channel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jmjuanes","download_url":"https://codeload.github.com/jmjuanes/electron-channel/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmjuanes%2Felectron-channel/sbom","scorecard":{"id":524509,"data":{"date":"2025-08-11","repo":{"name":"github.com/jmjuanes/electron-channel","commit":"157b10b69b067e126469d9591b17cf85d4b1d2f2"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Code-Review","score":0,"reason":"Found 0/12 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-20T03:59:45.396Z","repository_id":57221589,"created_at":"2025-08-20T03:59:45.397Z","updated_at":"2025-08-20T03:59:45.397Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32439175,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-29T18:12:22.909Z","status":"ssl_error","status_checked_at":"2026-04-29T18:11:33.322Z","response_time":110,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["channel","electron","electron-ipc","electron-plugin","events","ipc"],"created_at":"2024-10-25T12:06:36.532Z","updated_at":"2026-04-29T18:32:06.067Z","avatar_url":"https://github.com/jmjuanes.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# electron-channel\n\n\u003e A dead simple ipc wrapper for electron\n\n[![npm](https://img.shields.io/npm/v/electron-channel.svg?style=flat-square)](https://www.npmjs.com/package/electron-channel)\n[![npm](https://img.shields.io/npm/dt/electron-channel.svg?style=flat-square)](https://www.npmjs.com/package/electron-channel)\n[![npm](https://img.shields.io/npm/l/electron-channel.svg?style=flat-square)](https://github.com/jmjuanes/electron-channel)\n\nA very simple way to comunicate between the main and the render process in **electron**. It is based on `ipc` but uses callbacks in the render process instead of event listeners. \n\n## Example \n\nAn example of sending and handling messages between the render and the main process. The render process will send a request to the main process to read a file. The main process will read the file and send the content of the file to the render process.\n\n### Main process\n\n```javascript\n//Import dependencies\nvar fs = require('fs');\nvar channel = require('electron-channel/main');\n\n//Register a listener that reads the content of a file and return the file content\nchannel('read-file', function(data, done)\n{\n  //Data is an object with the following keys \n  // data.filename: path to the file to read \n  // data.encoding: default encoding\n  \n  //Read the file \n  return fs.readFile(data.filename, data.encoding, function(error, content)\n  {\n    //Call the done function with the error and the file content\n    return done(error, content);\n  });\n});\n```\n\n### Render process \n\n```javascript\n//Import dependencies \nvar channel = require('electron-channel/render');\n\n//Read the content of a file in the main process \nchannel('read-file', { filename: './file.txt', encoding: 'utf8'}, function(error, content)\n{\n  //Check the error reading the file \n  if(error){ /* do something with the error */ } \n  \n  //Work with the content of the file \n  // ...\n});\n```\n\n## API \n\n### Main process \n\nImport the channel manager in the main process by adding the following line: \n\n```javascript\nvar channel = require('electron-channel/main');\n```\n\n#### channel(name, listener)\n\nRegister a new channel that will listen to all events with the name `name`. For each request to this channel the `listener` function will be executed. \n\nThe `listener` method will be executed with the following arguments: \n\n- `data`: an object with the data sent by the render process. \n- `done`: a function used to reply to the render process. All the arguments passed to the `done` function will be the arguments of the callback function in the render process, so you can use it to reply data to the render process.\n\nExample: \n\n```javascript\nvar channel = require('electron-channel/main'); \n\n//Register a channel \nchannel('name', function(data, done)\n{\n  //Work with the data object \n  //... \n  \n  //Reply to the render process \n  return done();\n});\n```\n\n### Render process \n\nImport the channel manager in the render process by adding the following line: \n\n```javascript\nvar channel = require('electron-channel/render');\n```\n\n#### channel(name, data, callback)\n\nEmit a new request to the main process with the name `name`. The `data` argument must be an object with all the information that will be passed to the main process. \n\nWhen the `done` function in the main process is called, the `callback` function will be executed with all the arguments passed to the `done` function in the main process. \n\nExample: \n\n```javascript\nvar channel = require('electron-channel/render');\n\n//Create the object will all the data that you want to pass to the main process \nvar obj = { ... };\n\n//Emit a new request/message to the main process \nchannel('name', obj, function()\n{\n  //Work with the response \n  //...\n});\n```\n\n## License \n\n[MIT LICENSE](./LICENSE) \u0026copy; Josemi Juanes.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmjuanes%2Felectron-channel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjmjuanes%2Felectron-channel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmjuanes%2Felectron-channel/lists"}