OSSForks/node
1
0
Fork 0
mirror of https://github.com/zebrajr/node.git synced 2026-01-15 12:15:26 +00:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

doc: document error event on readline InterfaceConstructor

Browse Source 
Aims to document the error event introduced by cb3020d in v16.0.0.

Fixes: https://github.com/nodejs/node/issues/58289
PR-URL: https://github.com/nodejs/node/pull/61170
Fixes: https://github.com/nodejs/node/issues/61037
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
This commit is contained in:
Xavier Stouder
2025-12-27 17:52:40 +01:00
committed by GitHub
parent ed47077736
commit 0804ec4cfe
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/api/readline.md
View File

@@ -102,6 +102,17 @@ The listener function is called without passing any arguments.
The `InterfaceConstructor` instance is finished once the `'close'` event is
emitted.
### Event: `'error'`
<!-- YAML
added: v16.0.0
-->
The `'error'` event is emitted when an error occurs on the `input` stream
associated with the `node:readline` `Interface`.
The listener function is called with an `Error` object passed as the single argument.
### Event: `'line'`
<!-- YAML