doc: clarify when messageerror is emitted

jasnell · jasnell · commit 9ac404716446 · 2021-01-06T11:40:15.000-08:00
Adapting addaleax's explanation from the issue. Fixes: #36333 Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: #36780 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md
@@ -452,6 +452,12 @@ added:
 
 The `'messageerror'` event is emitted when deserializing a message failed.
 
+Currently, this event is emitted when there is an error occurring while
+instantiating the posted JS object on the receiving end. Such situations
+are rare, but can happen, for instance, when certain Node.js API objects
+are received in a `vm.Context` (where Node.js APIs are currently
+unavailable).
+
 ### `port.close()`
 <!-- YAML
 added: v10.5.0
