From d49ff34adb3f8f68d98376502c2893f97c04083b Mon Sep 17 00:00:00 2001 From: Jimmy Leung <43258070+hkleungai@users.noreply.github.com> Date: Sun, 4 May 2025 03:24:42 +0800 Subject: [PATCH] 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 --- doc/api/readline.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/api/readline.md b/doc/api/readline.md index 4f191127fd1..e3cb1ed0da6 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -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`