-
-
- 
- 
- 
- Find the full documentation on the website: -
+To do: +- gulp task to bundle dependencies using browserify and expose all of them -> dependency bundle +- dependency bundle can be imported by importScripts() +- code can just call `var myDependency = require('my-dependency');`, no matter if browser or node.js -- [**Quick start**](https://threads.js.org/getting-started) -- [**Basic usage**](https://threads.js.org/usage) -- [**Using observables**](https://threads.js.org/usage-observables) -- [**Thread pools**](https://threads.js.org/usage-pool) -- [**Advanced**](https://threads.js.org/usage-advanced) -## Webpack +## Configuration -Threads.js works with webpack. Usually all you need to do is adding the -[`threads-plugin`](https://github.com/andywer/threads-plugin). +```javascript +const config = require('threads').config; -See [Build with webpack](https://threads.js.org/getting-started#build-with-webpack) -on the website for details. +// These configuration properties are all optional +config.set({ + basepath : { + node : 'path/to/my/worker/scripts/directory', + web : 'path-or-url/to/my/worker/scripts/directory' + }, + fallback : { + slaveScriptUrl : 'path-or-url/to/dist/slave.js' // used for IE where you cannot pass code to a worker using a data URI + } +}); +``` - +## FAQ: Frequently Asked Questions -## Debug +#### Node: `require()`-ing relative paths in worker does not work (`Error: Cannot find module`) +Thank you, https://github.com/FlorianBruckner, for reporting the issues and helping to debug them! -We are using the [`debug`](https://github.com/visionmedia/debug) package to provide opt-in debug logging. All the package's debug messages have a scope starting with `threads:`, with different sub-scopes: +**Solution**: Pass down `__dirname` to worker and use it in `require()` (see [Issue 28](https://github.com/andywer/threads.js/issues/28#issuecomment-248505917)) -- `threads:master:messages` -- `threads:master:spawn` -- `threads:master:thread-utils` -- `threads:pool:${poolName || poolID}` -Set it to `DEBUG=threads:*` to enable all the library's debug logging. To run its tests with full debug logging, for instance: +## Change log + +See [CHANGELOG.md](./CHANGELOG.md). -``` -DEBUG=threads:* npm test -``` ## License -MIT +This library is published under the MIT license. See [LICENSE](./LICENSE) for details. + + +__Have fun and build something awesome!__ diff --git a/bower.json b/bower.json new file mode 100644 index 00000000..60cb5fee --- /dev/null +++ b/bower.json @@ -0,0 +1,25 @@ +{ + "name": "threads", + "version": "0.8.0", + "main": "dist/threads.browser.js", + "homepage": "https://github.com/andywer/threads.js", + "authors": [ + "Andy Wermke
-
- - Make web workers & worker threads as simple as a function call. -
- -npm install threads
- - Write code once, run it everywhere – in web workers and node worker threads. -
-- Call workers transparently, await results. It's never been easier. -
- -- Designed for modern day JavaScript and TypeScript code. -
- -- Built on functional paradigms and with modern APIs in mind, threads.js makes it easy to write clear, declarative code. -
-- Completely written in TypeScript – providing a robust code base and always shipping up-to-date types out of the box. -
-
- Works great with webpack – just need to add one extra plugin!
- Works with other bundlers, too.
-
- Web workers and worker threads turn out to be pretty versatile. -
- -- Outsourcing calculation-intensive code to one or multiple workers can improve performance drastically. -
-- Manage bulk tasks by using a thread pool. The pool will dispatch the tasks to workers in a controlled and predictable way. -
-- Offload business logic from the main thread, since this is where the rendering happens. Enjoy smooth 60 FPS. -
-- Security-relevant code should be shielded from other application code. Use worker to sandbox code and create secure enclaves. -
-- Serves as an abstraction layer for different worker implementations. -
- -- Tested on all major desktop operating systems -
-