Skip to content

Commit

Permalink
doc: add documentation for transferList arg at worker threads
Browse files Browse the repository at this point in the history
  • Loading branch information
juanarbol committed Apr 16, 2020
1 parent cbe955c commit 37e928c
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions doc/api/worker_threads.md
Expand Up @@ -564,6 +564,9 @@ changes:
occur as described in the [HTML structured clone algorithm][], and an error
will be thrown if the object cannot be cloned (e.g. because it contains
`function`s).
* `transferList` {Object[]} If one or more `MessagePort`-like objects
are passed in `workerData`, a `transferList` is required for those
items or [ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST][] will be thrown.
* `resourceLimits` {Object} An optional set of resource limits for the new
JS engine instance. Reaching these limits will lead to termination of the
`Worker` instance. These limits only affect the JS engine, and no external
Expand Down Expand Up @@ -751,6 +754,7 @@ active handle in the event system. If the worker is already `unref()`ed calling
[`'exit'` event]: #worker_threads_event_exit
[`AsyncResource`]: async_hooks.html#async_hooks_class_asyncresource
[`Buffer`]: buffer.html
[ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST]: errors.html#errors_err_missing_message_port_in_transfer_list
[`ERR_WORKER_NOT_RUNNING`]: errors.html#ERR_WORKER_NOT_RUNNING
[`EventEmitter`]: events.html
[`EventTarget`]: https://developer.mozilla.org/en-US/docs/Web/API/EventTarget
Expand Down

0 comments on commit 37e928c

Please sign in to comment.