@inquirer/prompts 5.3.7 → 5.4.0

package/README.md

@@ -169,6 +169,7 @@ The context options are:
 | input             | `NodeJS.ReadableStream` | no       | The stdin stream (defaults to `process.stdin`)               |
 | output            | `NodeJS.WritableStream` | no       | The stdout stream (defaults to `process.stdout`)             |
 | clearPromptOnDone | `boolean`               | no       | If true, we'll clear the screen after the prompt is answered |
+| signal            | `AbortSignal`           | no       | An AbortSignal to cancel prompts asynchronously              |
 
 Example:
 
@@ -191,16 +192,37 @@ const allowEmail = await confirm(
 
 ## Canceling prompt
 
-All prompt functions are returning a cancelable promise. This special promise type has a `cancel` method that'll cancel and cleanup the prompt.
+This can preferably be done with either an `AbortController` or `AbortSignal`.
+
+```js
+// Example 1: using built-in AbortSignal utilities
+import { confirm } from '@inquirer/prompts';
+
+const answer = await confirm({ ... }, { signal: AbortSignal.timeout(5000) });
+```
+
+```js
+// Example 1: implementing custom cancellation logic
+import { confirm } from '@inquirer/prompts';
+
+const controller = new AbortController();
+setTimeout(() => {
+  controller.abort(); // This will reject the promise
+}, 5000);
+
+const answer = await confirm({ ... }, { signal: controller.signal });
+```
+
+Alternatively, all prompt functions are returning a cancelable promise. This special promise type has a `cancel` method that'll cancel and cleanup the prompt.
 
 On calling `cancel`, the answer promise will become rejected.
 
 ```js
 import { confirm } from '@inquirer/prompts';
 
-const answer = confirm(...); // note: for this you cannot use `await`
+const promise = confirm(...); // Warning: for this pattern to work, `await` cannot be used.
 
-answer.cancel();
+promise.cancel();
 ```
 
 # Recipes
@@ -238,27 +260,18 @@ if (allowEmail) {
 ## Get default value after timeout
 
 ```js
-import { setTimeout } from 'node:timers/promises';
 import { input } from '@inquirer/prompts';
 
-const ac = new AbortController();
-const prompt = input({
-  message: 'Enter a value (timing out in 5 seconds)',
-});
-
-prompt
-  .finally(() => {
-    ac.abort();
-  })
-  // Silencing the cancellation error.
-  .catch(() => {});
+const answer = await input(
+  { message: 'Enter a value (timing out in 5 seconds)' },
+  { signal: AbortSignal.timeout(5000) },
+).catch((error) => {
+  if (error.name === 'AbortPromptError') {
+    return 'Default value';
+  }
 
-const defaultValue = setTimeout(5000, 'timeout', { signal: ac.signal }).then(() => {
-  prompt.cancel();
-  return 'Timed out!';
+  throw error;
 });
-
-const answer = await Promise.race([defaultValue, prompt]);
 ```
 
 ## Using as pre-commit/git hooks, or scripts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inquirer/prompts",
-  "version": "5.3.7",
+  "version": "5.4.0",
   "description": "Inquirer prompts, combined in a single package",
   "main": "./dist/cjs/index.js",
   "typings": "./dist/cjs/types/index.d.ts",
@@ -76,21 +76,21 @@
     }
   },
   "dependencies": {
-    "@inquirer/checkbox": "^2.4.6",
-    "@inquirer/confirm": "^3.1.21",
-    "@inquirer/editor": "^2.1.21",
-    "@inquirer/expand": "^2.1.21",
-    "@inquirer/input": "^2.2.8",
-    "@inquirer/number": "^1.0.9",
-    "@inquirer/password": "^2.1.21",
-    "@inquirer/rawlist": "^2.2.3",
-    "@inquirer/search": "^1.0.6",
-    "@inquirer/select": "^2.4.6"
+    "@inquirer/checkbox": "^2.5.0",
+    "@inquirer/confirm": "^3.2.0",
+    "@inquirer/editor": "^2.2.0",
+    "@inquirer/expand": "^2.2.0",
+    "@inquirer/input": "^2.3.0",
+    "@inquirer/number": "^1.1.0",
+    "@inquirer/password": "^2.2.0",
+    "@inquirer/rawlist": "^2.3.0",
+    "@inquirer/search": "^1.1.0",
+    "@inquirer/select": "^2.5.0"
   },
   "devDependencies": {
-    "@inquirer/type": "^1.5.2"
+    "@inquirer/type": "^1.5.3"
   },
   "homepage": "https://github.com/SBoudrias/Inquirer.js/blob/main/packages/prompts/README.md",
   "sideEffects": false,
-  "gitHead": "056e26aa6497e0036864d032f9eb8d821de821e7"
+  "gitHead": "0c039599ef88fe9eb804fe083ee386ec906a856f"
 }