Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit d49ff34

Browse filesBrowse files
hkleungaiaduh95
hkleungai
authored and
aduh95
committed
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: #55456 Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent b13d5d1 commit d49ff34
Copy full SHA for d49ff34

File tree

Expand file treeCollapse file tree

1 file changed

+1
-0
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+1
-0
lines changed
Open diff view settings
Collapse file

‎doc/api/readline.md‎

Copy file name to clipboardExpand all lines: doc/api/readline.md
+1Lines changed: 1 addition & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -710,6 +710,7 @@ added: v17.0.0
710710
**Default:** `500`.
711711
* `tabSize` {integer} The number of spaces a tab is equal to (minimum 1).
712712
**Default:** `8`.
713+
* `signal` {AbortSignal} Allows closing the interface using an AbortSignal.
713714
* Returns: {readlinePromises.Interface}
714715

715716
The `readlinePromises.createInterface()` method creates a new `readlinePromises.Interface`

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.