@inquirer/input v2.1.6

@inquirer/input

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

Installation

npm install @inquirer/input

yarn add @inquirer/input

Usage

import input from '@inquirer/input';

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

Options

Theming

You can theme a prompt by passing a theme object option. The theme object only need to includes the keys you wish to modify, we'll fallback on the defaults for the rest.

type Theme = {
  prefix: string;
  spinner: {
    interval: number;
    frames: string[];
  };
  style: {
    answer: (text: string) => string;
    message: (text: string) => string;
    error: (text: string) => string;
    defaultAnswer: (text: string) => string;
  };
};

License

Copyright (c) 2023 Simon Boudrias (twitter: @vaxilart) Licensed under the MIT license.