@inquirer/testing 3.2.0 → 3.3.0

package/README.md

@@ -73,11 +73,42 @@ describe('input prompt', () => {
 
 - `answer` (`Promise`) - Resolves when an answer is provided and valid
 - `getScreen` (`({ raw?: boolean }) => string`) - Returns the current screen content. By default strips ANSI codes
+- `nextRender` (`() => Promise<void>`) - Wait for the next screen update. Use after triggering async actions (e.g. pressing enter with validation). Coalesces rapid back-to-back renders so a single `await nextRender()` captures the final settled state
 - `events` - Utilities to interact with the prompt:
   - `keypress(key: string | KeyObject)` - Trigger a keypress event
   - `type(text: string)` - Type text into the prompt
 - `getFullOutput` (`() => Promise<string>`) - Returns the full output interpreted through a virtual terminal, resolving ANSI escape sequences into the actual screen state
 
+### Async actions and `nextRender()`
+
+When a keypress triggers an asynchronous action (such as input validation), the screen won't update synchronously. Use `nextRender()` to wait for the prompt to settle before reading the screen:
+
+```ts
+import { render } from '@inquirer/testing';
+import input from '@inquirer/input';
+
+it('shows a validation error', async () => {
+  const { answer, events, getScreen, nextRender } = await render(input, {
+    message: 'Enter a number',
+    validate: (value) => /^\d+$/.test(value) || 'Must be a number',
+  });
+
+  events.type('abc');
+  events.keypress('enter');
+
+  await nextRender(); // wait for validation to complete and the error to render
+  expect(getScreen()).toContain('Must be a number');
+
+  events.keypress('backspace');
+  events.keypress('backspace');
+  events.keypress('backspace');
+  events.type('42');
+  events.keypress('enter');
+
+  await expect(answer).resolves.toEqual('42');
+});
+```
+
 ### Unit Testing Example
 
 You can refer to the [`@inquirer/input` test suite](https://github.com/SBoudrias/Inquirer.js/blob/main/packages/input/input.test.ts) for a comprehensive unit testing example using `render()`.

package/dist/index.d.ts

@@ -19,5 +19,6 @@ export declare function render<Value, const Config>(prompt: Prompt<Value, Config
     getFullOutput: ({ raw }?: {
         raw?: boolean;
     }) => Promise<string>;
+    nextRender: () => Promise<void>;
 }>;
 export {};

package/dist/index.js

@@ -30,6 +30,20 @@ export async function render(prompt, config, options) {
             }
         },
     };
+    let rendersConsumed = output.writeCount;
+    function nextRender() {
+        const waitForRender = output.writeCount > rendersConsumed
+            ? Promise.resolve()
+            : new Promise((resolve) => output.once('render', resolve));
+        // After detecting a render, let the event loop settle so that multiple
+        // synchronous-ish renders (e.g. validation: loading → error) are coalesced.
+        return waitForRender.then(() => new Promise((resolve) => {
+            setImmediate(() => {
+                rendersConsumed = output.writeCount;
+                resolve();
+            });
+        }));
+    }
     return {
         answer,
         input,
@@ -44,5 +58,6 @@ export async function render(prompt, config, options) {
                 return fullOutput;
             return interpretTerminalOutput(fullOutput);
         },
+        nextRender,
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inquirer/testing",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Inquirer testing utilities",
   "keywords": [
     "answer",
@@ -167,5 +167,5 @@
   },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "gitHead": "fd001c191cfb287b430d5e90cb159cf8f6500dc5"
+  "gitHead": "526eca2e64853510821ffd457561840ec0cbfb93"
 }