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

hkleungai · aduh95 · commit d49ff34adb3f · 2025-05-08T09:59:50.000+02:00
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>
diff --git 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`
