Skip to content

improve doc : inform about bare option #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
valette wants to merge 1 commit into
base: master
Choose a base branch
from
Open

improve doc : inform about bare option #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion readme.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ contain output from the worker:
var work = require('webworkify')
```

## var w = work(require(modulePath))
## var w = work(require(modulePath) [, options])

Return a new
[web worker](https://developer.mozilla.org/en-US/docs/Web/API/Worker)
Expand All @@ -76,6 +76,9 @@ The worker `w` returned by `webworkify` has the property `objectURL` attached.
`w.objectURL` refers to the Object URL that was used to pass the module's source
to the worker, and can be cleaned up using `URL.revokeObjectURL()`. (See [example](https://github.com/substack/webworkify/blob/master/example/main.js))

### options
- bare - the return value will be the blob constructed with the worker's code and not the web worker itself.

# install

With [npm](https://npmjs.org) do:
Expand Down