@inquirer/password

Inquirer password prompt

Usage no npm install needed!

<script type="module">
  import inquirerPassword from 'https://cdn.skypack.dev/@inquirer/password';
</script>

README

@inquirer/password

Interactive password input component for command line interfaces. Supports input validation and masked or transparent modes.

Password prompt

Installation

npm install @inquirer/password

yarn add @inquirer/password

Usage

import password from '@inquirer/password';

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

Options

Property Type Required Description
message string yes The question to ask
mask boolean no Show a * mask over the input or keep it transparent
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.

License

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