readline: add support for Symbol.dispose

nodejs · Mar 2, 2025 · 3949f24 · 3949f24
1 parent d1ec948
commit 3949f24
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/doc/api/readline.md b/doc/api/readline.md
@@ -272,6 +272,14 @@ the `'close'` event will be emitted.
 Calling `rl.close()` does not immediately stop other events (including `'line'`)
 from being emitted by the `InterfaceConstructor` instance.
 
+### `rl[Symbol.dispose]()`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+Alias for `rl.close()`.
+
 ### `rl.pause()`
 
 <!-- YAML

diff --git a/lib/internal/readline/interface.js b/lib/internal/readline/interface.js
@@ -1371,6 +1371,7 @@ class Interface extends InterfaceConstructor {
     return this[kLineObjectStream];
   }
 }
+Interface.prototype[SymbolDispose] = Interface.prototype.close;
 
 module.exports = {
   Interface,