nodejs
/
node
mirror of https://github.com/nodejs/node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add missing options.signal to readlinePromises.createInterface() 

From the source code, `readlinePromises.createInterface()` calls
`new Interface()` imported from `internal/readline/interface`, which
works the same as the non-promise version. If non-promise version
accepts options.signal, it should also work for
`readlinePromises.createInterface()`. Hence this information need to be
indicated in the documentation.

Refs: https://github.com/nodejs/node/blob/main/lib/readline/promises.js
PR-URL: https://github.com/nodejs/node/pull/55456
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
This commit is contained in:
Jimmy Leung 2025-05-04 03:24:42 +08:00 committed by Antoine du Hamel
parent b13d5d14bd
commit d49ff34adb
No known key found for this signature in database
GPG Key ID: 21D900FFDB233756
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/api/readline.md
View File

@ -710,6 +710,7 @@ added: v17.0.0
**Default:** `500`.
* `tabSize` {integer} The number of spaces a tab is equal to (minimum 1).
**Default:** `8`.
* `signal` {AbortSignal} Allows closing the interface using an AbortSignal.
* Returns: {readlinePromises.Interface}
The `readlinePromises.createInterface()` method creates a new `readlinePromises.Interface`