Commit 7f0999c
committed
doc: document REPL DEP0185 throws and uncaught-exception behavior
Two doc-only improvements to `doc/api/repl.md`, both filling gaps left
by recent semver-major REPL changes:
1. `repl.REPLServer` is an ES class; calling it without `new` is
End-of-Life (DEP0185) and throws a native V8 `TypeError`. The
"Class: REPLServer" section now notes this and links to the DEP0185
entry in `doc/api/deprecations.md`. No `Stability: 0` banner is
added because the class itself is not deprecated — only the
`new`-less invocation is — matching the parallel DEP0184/DEP0195
"classes without `new`" convention.
2. PR #64034 ("repl: use inspector over vm") removed the old
"Global uncaught exceptions" subsection because the `domain`-based
restrictions it documented no longer exist. A new top-level
`### Error handling` section documents the current model (mirroring
the `### Error handling` convention in async_hooks/http2/quic),
anchored to the existing `Uncaught Error: REPL await` example.
Refs: #59495
Refs: #54869
Refs: #54842
Refs: #64034
PR-URL: #64993
Signed-off-by: Adrian Estrada <edsadr@gmail.com>1 parent a24bd27 commit 7f0999c
1 file changed
Lines changed: 13 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -232,6 +232,15 @@ undefined | |||
| 232 | 232 | undefined | |
| 233 | 233 | ``` | |
| 234 | 234 | ||
| 235 | + ### Error handling | ||
| 236 | + | ||
| 237 | + By default, uncaught exceptions in the REPL are printed to the output stream | ||
| 238 | + (as with `Uncaught Error: REPL await` above). `uncaughtException` listeners | ||
| 239 | + can be added freely in both standalone and nested REPLs. The `handleError` | ||
| 240 | + option of [`repl.start()`][] can customize this behavior, including | ||
| 241 | + forwarding exceptions to [`'uncaughtException'`][] by returning | ||
| 242 | + `'unhandled'`. | ||
| 243 | + | ||
| 235 | 244 | ### Reverse-i-search | |
| 236 | 245 | ||
| 237 | 246 | <!-- YAML | |
@@ -425,6 +434,9 @@ const firstInstance = repl.start(options); | |||
| 425 | 434 | const secondInstance = new repl.REPLServer(options); | |
| 426 | 435 | ``` | |
| 427 | 436 | ||
| 437 | + Calling `repl.REPLServer()` without the `new` keyword throws a `TypeError` | ||
| 438 | + (see [DEP0185][]). | ||
| 439 | + | ||
| 428 | 440 | ### Event: `'exit'` | |
| 429 | 441 | ||
| 430 | 442 | <!-- YAML | |
@@ -1127,6 +1139,7 @@ avoiding open network interfaces. | |||
| 1127 | 1139 | ||
| 1128 | 1140 | Original code from <https://gist.github.com/TooTallNate/2053342>. | |
| 1129 | 1141 | ||
| 1142 | + [DEP0185]: deprecations.md#dep0185-instantiating-noderepl-classes-without-new | ||
| 1130 | 1143 | [TTY keybindings]: readline.md#tty-keybindings | |
| 1131 | 1144 | [ZSH]: https://en.wikipedia.org/wiki/Z_shell | |
| 1132 | 1145 | [`'uncaughtException'`]: process.md#event-uncaughtexception | |
0 commit comments