{"id":20679535,"url":"https://github.com/rwv/browser-web-worker","last_synced_at":"2025-04-19T23:49:40.290Z","repository":{"id":262404189,"uuid":"886709800","full_name":"rwv/browser-web-worker","owner":"rwv","description":"👷 Run Web Workers in Node.js using a real Chrome browser via Puppeteer.","archived":false,"fork":false,"pushed_at":"2025-04-10T14:56:15.000Z","size":281,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-19T23:49:36.171Z","etag":null,"topics":["web-workers","worker"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/browser-web-worker","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/rwv.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}},"created_at":"2024-11-11T13:17:20.000Z","updated_at":"2025-03-06T14:39:10.000Z","dependencies_parsed_at":"2025-02-03T15:31:12.370Z","dependency_job_id":"546e9605-23d0-4393-b466-92dc719c1f09","html_url":"https://github.com/rwv/browser-web-worker","commit_stats":null,"previous_names":["rwv/browser-worker","rwv/browser-web-worker"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwv%2Fbrowser-web-worker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwv%2Fbrowser-web-worker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwv%2Fbrowser-web-worker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwv%2Fbrowser-web-worker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rwv","download_url":"https://codeload.github.com/rwv/browser-web-worker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249830846,"owners_count":21331357,"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":["web-workers","worker"],"created_at":"2024-11-16T21:26:22.289Z","updated_at":"2025-04-19T23:49:40.273Z","avatar_url":"https://github.com/rwv.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Browser Web Worker\n\n[![Build](https://github.com/rwv/browser-web-worker/actions/workflows/build.yml/badge.svg)](https://github.com/rwv/browser-web-worker/actions/workflows/build.yml)\n[![NPM Version](https://img.shields.io/npm/v/browser-web-worker)](https://www.npmjs.com/package/browser-web-worker)\n[![GitHub License](https://img.shields.io/github/license/rwv/browser-web-worker)](https://github.com/rwv/browser-web-worker/blob/main/LICENSE)\n\nRun Web Workers in Node.js using a real Chrome browser via Puppeteer.\n\n## Features\n\n- Create Web Workers from strings, files, or URLs\n- Full Web Worker API support including message passing\n- Event handling (message, error, etc.)\n- Built on top of Puppeteer for real browser compatibility\n- TypeScript support\n- Comprehensive test coverage\n\n## Installation\n\n```bash\npnpm add browser-web-worker puppeteer\n```\n\n## Usage\n\n### Basic Example\n\n```typescript\nimport { createWorkerFromString } from \"browser-web-worker\";\nimport puppeteer from \"puppeteer\";\n\n// Launch browser\nconst browser = await puppeteer.launch();\nconst page = await browser.newPage();\nawait page.goto(\"about:blank\");\n\n// Create a worker from a string\nconst workerScript = `self.addEventListener('message', (event) =\u003e { self.postMessage(event.data); });`;\nconst worker = await createWorkerFromString(workerScript, page);\n\n// Set up message handler\nworker.onmessage = (event) =\u003e {\n  console.log(\"Received:\", event.data);\n};\n// Send a message to the worker\nworker.postMessage({ hello: \"world\" });\n\n// Clean up\nawait worker.terminate();\nawait browser.close();\n```\n\n### Creating Workers\n\nYou can create workers in three ways:\n\n```typescript\nimport {\n  createWorkerFromString,\n  createWorkerFromFile,\n  createWorkerFromURL,\n} from \"browser-web-worker\";\n\n// 1. From a string\nconst worker1 = await createWorkerFromString(workerScript, page);\n// 2. From a file\nconst worker2 = await createWorkerFromFile(\"./path/to/worker.js\", page);\n// 3. From a URL, make sure the worker url is the same origin as the page\nconst worker3 = await createWorkerFromURL(\n  \"https://example.com/worker.js\",\n  page,\n);\n```\n\n## TODOs\n\n- Fix origin check to allow worker from `file://` scheme and handle cross-origin worker scripts securely\n- Add support for transferable objects in postMessage (Blob, ArrayBuffer, MessagePort, etc.)\n- Implement proper worker termination with cleanup of all resources and event listeners\n- Add examples for common use cases in documentation\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frwv%2Fbrowser-web-worker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frwv%2Fbrowser-web-worker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frwv%2Fbrowser-web-worker/lists"}