Commit a800b5b
doc: clarify when messageerror is emitted
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>1 parent e973bdc commit a800b5b
1 file changed
Lines changed: 6 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -356,6 +356,12 @@ added: v14.5.0 | |||
| 356 | 356 | ||
| 357 | 357 | The `'messageerror'` event is emitted when deserializing a message failed. | |
| 358 | 358 | ||
| 359 | + Currently, this event is emitted when there is an error occurring while | ||
| 360 | + instantiating the posted JS object on the receiving end. Such situations | ||
| 361 | + are rare, but can happen, for instance, when certain Node.js API objects | ||
| 362 | + are received in a `vm.Context` (where Node.js APIs are currently | ||
| 363 | + unavailable). | ||
| 364 | + | ||
| 359 | 365 | ### `port.close()` | |
| 360 | 366 | <!-- YAML | |
| 361 | 367 | added: v10.5.0 | |
0 commit comments