Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@inquirer/input

Package Overview
Dependencies
Maintainers
3
Versions
82
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@inquirer/input

Inquirer input text prompt

  • 0.0.12-alpha.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2.1M
increased by1.92%
Maintainers
3
Weekly downloads
 
Created
Source

@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

PropertyTypeRequiredDescription
messagestringyesThe question to ask
defaultstringnoDefault value if no answer is provided (clear it by pressing backspace)
transformer(string, { isFinal: boolean }) => stringnoTransform/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.
validatestring => boolean | string | Promise<string | boolean>noOn 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.

License

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

Keywords

FAQs

Package last updated on 10 Jul 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc