4.0.1 • Published 8 months ago

@inquirer/password v4.0.1

Weekly downloads
3
License
MIT
Repository
github
Last release
8 months 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.
themeSee ThemingnoCustomize 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.

4.0.1

8 months ago

4.0.0

9 months ago

2.2.0

10 months ago

3.0.1

10 months ago

3.0.0

10 months ago

2.1.9

1 year ago

2.1.16

12 months ago

2.1.17

12 months ago

2.1.14

12 months ago

2.1.15

12 months ago

2.1.12

1 year ago

2.1.13

12 months ago

2.1.10

1 year ago

2.1.11

1 year ago

2.1.18

11 months ago

2.1.19

11 months ago

2.1.21

11 months ago

2.1.22

11 months ago

2.1.20

11 months ago

2.1.8

1 year ago

2.1.7

1 year ago

2.1.6

1 year ago

2.1.5

1 year ago

2.1.4

1 year ago

2.1.3

1 year ago

2.1.2

1 year ago

2.1.1

1 year ago

2.1.0

1 year ago

2.0.2

1 year ago

2.0.1

1 year ago

2.0.0

1 year ago

1.1.16

1 year ago

1.1.15

1 year ago

1.1.9

2 years ago

1.1.8

2 years ago

1.1.7

2 years ago

1.1.6

2 years ago

1.1.5

2 years ago

1.1.4

2 years ago

1.1.3

2 years ago

1.1.12

2 years ago

1.1.11

2 years ago

1.1.10

2 years ago

1.1.14

2 years ago

1.1.13

2 years ago

1.1.2

2 years ago

1.1.1

2 years ago

1.0.2

2 years ago

1.1.0

2 years ago

1.0.1

2 years ago

1.0.9

2 years ago

1.0.8

2 years ago

1.0.7

2 years ago

1.0.6

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.11

2 years ago

1.0.10

2 years ago

1.0.0

2 years ago

0.1.0

2 years ago

0.0.27-alpha.0

3 years ago

0.0.28-alpha.0

3 years ago

0.0.25-alpha.0

3 years ago

0.0.21-alpha.0

3 years ago

0.0.22-alpha.0

3 years ago

0.0.23-alpha.0

3 years ago

0.0.20-alpha.0

3 years ago

0.0.19-alpha.0

3 years ago

0.0.18-alpha.0

3 years ago

0.0.17-alpha.0

3 years ago

0.0.16-alpha.0

4 years ago

0.0.15-alpha.0

4 years ago

0.0.14-alpha.0

4 years ago

0.0.13-alpha.0

4 years ago

0.0.12-alpha.0

5 years ago

0.0.11-alpha.0

5 years ago

0.0.10-alpha.0

5 years ago

0.0.9-alpha.0

5 years ago

0.0.8-alpha.0

5 years ago

0.0.6-alpha.0

6 years ago

0.0.5-alpha.0

6 years ago

0.0.4-alpha.0

6 years ago