Skip to content

Commit 669c138

Browse files
committed
Update docs on constructor options. Fixes #36.
1 parent 3aeb647 commit 669c138

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,9 @@ operations on the provided data.
3232
*Arguments*
3333
* `data`: This is the data you wish to operate on. Will often be an array, but the only restrictions are that your values are serializable as JSON.
3434
* `options` (optional): Some options for your job
35-
* `legacyEvalPath` (optional): The file eval.js must be included for IE 10 support. This option specifies the path to the eval.js file. By default it will look in the same location as parallel.js
35+
* `evalPath` (optional): This is the path to the file eval.js. This is required when running in node, and required for some browsers (IE 10) in order to work around cross-domain restrictions for web workers. Defaults to the same location as parallel.js in node environments, and `null` in the browser.
3636
* `maxWorkers` (optional): The maximum number of permitted worker threads. This will default to 4, or the number of cpus on your computer if you're running node
37+
* `synchronous` (optional): If webworkers are not available, whether or not to fall back to synchronous processing using `setTimeout`. Defaults to `true`.
3738

3839
*Example*
3940
```javascript

0 commit comments

Comments
 (0)