Skip to content

add notes preventing docker problems #310

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add notes preventing docker problems #310

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
13 changes: 13 additions & 0 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,19 @@ const worker = await spawn(BlobWorker.fromText(MyWorker))

Bundle this module and you will obtain a stand-alone bundle that has its worker inlined. This is particularly useful for libraries using threads.js.

## Docker

When running in docker, you may frequently run into the error:

```
Error: Timeout: Did not receive an init message from worker after 10000ms. Make sure the worker calls expose().
```

Docker may need additional time to spawn the workers. There is two ways to do this:

* set the environment variable `THREADS_WORKER_INIT_TIMEOUT=x0000`
* provide `spawn` with `options.timeout` ex. `spawn(new Worker('worker.js'), { timeout: x0000 })`

## TypeScript

### Type-safe workers
Expand Down