{"id":15388534,"url":"https://github.com/deebloo/worker","last_synced_at":"2025-04-15T17:32:47.693Z","repository":{"id":31783525,"uuid":"35349939","full_name":"deebloo/worker","owner":"deebloo","description":"A tiny library to make using web workers easier.","archived":false,"fork":false,"pushed_at":"2023-12-15T14:38:14.000Z","size":16064,"stargazers_count":37,"open_issues_count":4,"forks_count":5,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-05-10T05:04:12.068Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/deebloo.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-05-09T23:51:09.000Z","updated_at":"2023-12-03T07:51:39.000Z","dependencies_parsed_at":"2024-10-01T14:57:17.737Z","dependency_job_id":"f31f898f-e41e-4e07-9593-dcd038dcb977","html_url":"https://github.com/deebloo/worker","commit_stats":null,"previous_names":["deebloo/workers"],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deebloo%2Fworker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deebloo%2Fworker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deebloo%2Fworker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deebloo%2Fworker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deebloo","download_url":"https://codeload.github.com/deebloo/worker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223321558,"owners_count":17126374,"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-10-01T14:57:11.002Z","updated_at":"2024-11-08T12:02:17.385Z","avatar_url":"https://github.com/deebloo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# $worker\n\nA tiny library to help make using web workers easier. (\u003c1k)\n\nFor more info on web workers look [here](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers)\n\n### Install\n\n```\nnpm i inline-web-worker --save\n```\n\n#### Support\nChome, Firefox, Safari, and IE11+\n\n### Basic Usage\n\n```JS\nvar $worker = require('inline-web-worker');\n\n// if using as global\nvar $worker = window.$worker;\n\n// pass in a function to be run in a separate thread\nvar myWorker = $worker().create(function () {\n    self.postMessage('Hello World');\n});\n\n// run the worker respond to the promise\nmyWorker.run().then(function (e) {\n    console.log(e.data); // 'Hello World'\n});\n```\n\n### API\n\n#### $worker\nfactory - creates instance of $worker that can then be used to create web workers\n\nExample:\n```JS\nvar worker = $worker();\n```\n\n#### $worker().create()\ncreates a new web worker\n\n| Arg     | Type     | description                         |\n| --------|----------|-------------------------------------|\n| fn      | Function | the function to run in a web worker |\n\nExample:\n```JS\nfunction helloWorld() {\n    self.postMessage('Hello World');\n}\n\nvar myWorker = $worker().create(helloWorld);\n```\n\n#### $worker().create().run()\nPost data for the web worker to use. Runs the web worker and returns a promise;\n\n| Arg     | Type    | description |\n| --------|---------|-------|\n| data  | * | the data to be posted (cannot be function)  |\n\nExample:\n```JS\n$worker()\n  .create(function (e) {\n      self.postMessage(e.data.toUpperCase());\n  })\n  .run('hello world')\n  .then(function (e) {\n      console.log(e.data) // HELLO WORLD\n  });\n```\n\n#### $worker().runAll()\nRun all workers in a group. resolves promise when all workers are successful.\n\n| Arg     | Type    | description |\n| --------|---------|-------|\n| data  | * | the data to be posted (cannot be function)  |\n\nExample:\n```JS\nvar workerGroup = $worker();\n\nworkerGroup.create( ... );\nworkerGroup.create( ... );\n\nworkerGroup\n    .runAll([...data])\n    .then(function () {\n        ... do stuff\n    });\n```\n\n\n#### $worker().list()\nReturns a list of all of the created workers\n\nExample:\n```JS\nvar workerGroup = $worker();\n\nworkerGroup.create( ... );\nworkerGroup.create( ... );\n\nworkerGroup.list().length === 2\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeebloo%2Fworker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeebloo%2Fworker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeebloo%2Fworker/lists"}