Package Exports

@inquirer/input
@inquirer/input/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@inquirer/input) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

`@inquirer/input`

Interactive free text input component for command line interfaces. Supports validation, filtering, transformation, etc.

Input prompt

Installation

npm install @inquirer/input

yarn add @inquirer/input

Usage

import input from '@inquirer/input';

const answer = await input({ message: 'Enter your name' });

Options

Property	Type	Required	Description
message	`string`	yes	The question to ask
default	`string`	no	Default value if no answer is provided (clear it by pressing backspace)
transformer	`(string, { isFinal: boolean }) => string`	no	Transform/Format the raw value entered by the user. Once the prompt is completed, `isFinal` will be `true`. This function is purely visual; to modify the answer, use the `filter` option.
validate	`string => boolean \| string \| Promise<string \| boolean>`	no	On submit, validate the filtered answered content. When returning a string, it'll be used as the error message displayed to the user. Note: returning a rejected promise, we'll assume a code error happened and crash.

@inquirer/input