1.0.0 • Published 2 years ago

@developertheexplorer/password v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

@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

PropertyTypeRequiredDescription
messagestringyesThe question to ask
maskbooleannoShow a * mask over the input or keep it transparent
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) 2022 Simon Boudrias (twitter: @vaxilart) Licensed under the MIT license.