doc: add missing options.signal to readlinePromises.createInterface() · nodejs/node@5193735 · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 633
• Pull requests 755
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 5193735

Browse filesBrowse the repository at this point in the historyBrowse files

hkleungai

authored and

marco-ippolito

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 fd44af7 commit 5193735
Copy full SHA for 5193735

1 file changed

+1Lines changed: 1 addition & 0 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • readline.md

Expand file treeCollapse file tree

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 number	Diff line number	Diff line change
@@ -698,6 +698,7 @@ added: v17.0.0
698	698	**Default:** `500`.
699	699	* `tabSize` {integer} The number of spaces a tab is equal to (minimum 1).
700	700	**Default:** `8`.
	701	+ * `signal` {AbortSignal} Allows closing the interface using an AbortSignal.
701	702	* Returns: {readlinePromises.Interface}
702	703
703	704	The `readlinePromises.createInterface()` method creates a new `readlinePromises.Interface`

0 commit comments

Comments

0 (0)