Skip to content

doc: document error event on readline InterfaceConstructor #61170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Xstoudi wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −0
Open

doc: document error event on readline InterfaceConstructor #61170

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions doc/api/readline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,19 @@ 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 `readline` `Interface`.

The listener function is called with an Error object passed as the single argument.
Copy link
Member

@lpinca lpinca Dec 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The listener function is called with an Error object passed as the single argument.
The listener function is called with an `Error` object passed as the single argument.


If no `'error'` event handler is attached to the `InterfaceConstructor` instance,
errors will be thrown as unhandled error events, which may crash the process.

Comment on lines +115 to +117
Copy link
Member

@lpinca lpinca Dec 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If no `'error'` event handler is attached to the `InterfaceConstructor` instance,
errors will be thrown as unhandled error events, which may crash the process.

This is standard behavior.

### Event: `'line'`

<!-- YAML
Expand Down
Loading