Skip to content

Commit 9acf6af

Browse files
authored
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 <[email protected]>
1 parent 1b2bf2d commit 9acf6af

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

doc/api/readline.md

+1
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)