Skip to content

doc: improve worker_threads documentation #26110

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

Closed
addaleax wants to merge 4 commits into from
Closed

doc: improve worker_threads documentation #26110

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3e672dd
doc: improve worker_threads documentation
addaleax Feb 14, 2019
2bd5cd7
fixup! doc: improve worker_threads documentation
addaleax Feb 14, 2019
919fd07
fixup! doc: improve worker_threads documentation
addaleax Feb 15, 2019
b96ed3b
fixup! doc: improve worker_threads documentation
addaleax Feb 17, 2019
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
Prev Previous commit
Next Next commit
fixup! doc: improve worker_threads documentation
  • Loading branch information
@addaleax
addaleax committed Feb 15, 2019
commit 919fd07151495f55c60c59b79862962d459e1665
16 changes: 13 additions & 3 deletions doc/api/worker_threads.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,9 @@ added: v10.5.0
An arbitrary JavaScript value that contains a clone of the data passed
Copy link
Copy Markdown
Member

@jasnell jasnell Feb 15, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be good to include more of a description of what "clone" here means in general. I know there are a few bits and pieces of an explanation through the doc, but coalescing those into a single section with some information on what types of values cannot be cloned, would be good.

Copy link
Copy Markdown
Member Author

@addaleax addaleax Feb 15, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jasnell How does 919fd07 sound to you?

to this thread’s `Worker` constructor.

The data is cloned as if using [`postMessage()`][`port.postMessage()`],
using the [HTML structured clone algorithm][].
Comment thread
addaleax marked this conversation as resolved.
Outdated

```js
const { Worker, isMainThread, workerData } = require('worker_threads');

Expand Down Expand Up @@ -222,10 +225,16 @@ added: v10.5.0

Sends a JavaScript value to the receiving side of this channel.
`value` will be transferred in a way which is compatible with
the [HTML structured clone algorithm][]. In particular, it may contain circular
references and objects like typed arrays that the `JSON` API is not able
to stringify.
the [HTML structured clone algorithm][].

In particular, the significant differences to `JSON` are:
- `value` may contain circular references.
- `value` may contain instances of builtin JS types such as `RegExp`s,
`BigInt`s, `Map`s, `Set`s, etc.
- `value` may contained typed arrays, both using `ArrayBuffer`s
and `SharedArrayBuffer`s. and
Comment thread
addaleax marked this conversation as resolved.
Outdated
- `value` may contain [`WebAssembly.Module`][] instances.
- `value` may not contain native (C++-backed) objects other than `MessagePort`s.

```js
const { MessageChannel } = require('worker_threads');
Expand Down Expand Up @@ -567,6 +576,7 @@ active handle in the event system. If the worker is already `unref()`ed calling
[`MessagePort`]: #worker_threads_class_messageport
[`SharedArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer
[`Uint8Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array
[`WebAssembly.Module`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/Module
[`Worker`]: #worker_threads_class_worker
[`'close'` event]: #worker_threads_event_close
Comment thread
addaleax marked this conversation as resolved.
Outdated
[`cluster` module]: cluster.html
Expand Down