inquirer-press-to-continue

Installation

Make sure you have inquirer installed:

1npm install inquirer

Then, install inquirer-press-to-continue:

1npm install inquirer-press-to-continue

Usage

1import inquirer from 'inquirer';
2import PressToContinuePrompt from 'inquirer-press-to-continue';
3import type { KeyDescriptor } from 'inquirer-press-to-continue';
4
5inquirer.registerPrompt('press-to-continue', PressToContinuePrompt);
6
7const { key: enterKey } = await inquirer.prompt<{ key: KeyDescriptor }>({
8  name: 'key',
9  type: 'press-to-continue',
10  enter: true,
11});
12
13console.log(enterKey.value); // "enter"
14
15const { key: anyKey } = await inquirer.prompt<{ key: KeyDescriptor }>({
16  name: 'key',
17  type: 'press-to-continue',
18  anyKey: true,
19  pressToContinueMessage: 'Press a key to continue...',
20});
21
22console.log(anyKey.value);

API

key

Type: string

The key the user should press to continue.

anyKey

Type: boolean

Whether to allow the user to press any key to continue.

enter

Type: boolean

Only allow the enter key to be pressed.

pressToContinueMessage

Type: string

Custom message for prompting the user to press a key to continue.