@inquirer/password
TypeScript icon, indicating that this package has built-in type declarations

2.1.10 • Public • Published

@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.
theme See Theming no Customize look of the prompt.

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;
    help: (text: string) => string;
  };
};

License

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

Package Sidebar

Install

npm i @inquirer/password

Weekly Downloads

391,814

Version

2.1.10

License

MIT

Unpacked Size

15.2 kB

Total Files

8

Last publish

Collaborators

  • sboudrias
  • danielchatfield
  • mischah