doc: clarify when messageerror is emitted

Adapting addaleax's explanation from the issue. Fixes: #36333 Signed-off-by: James M Snell <[email protected]> PR-URL: #36780 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Juan José Arboleda <[email protected]>
nodejs · May 1, 2021 · a800b5b · a800b5b
1 parent e973bdc
commit a800b5b
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md
@@ -356,6 +356,12 @@ added: v14.5.0
 
 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