@inquirer/password 2.1.11 → 2.1.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +18 -1
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -6,12 +6,29 @@ Interactive password input component for command line interfaces. Supports input
6
6
 
7
7
  # Installation
8
8
 
9
+ <table>
10
+ <tr>
11
+ <th>npm</th>
12
+ <th>yarn</th>
13
+ </tr>
14
+ <tr>
15
+ <td>
16
+
9
17
  ```sh
10
18
  npm install @inquirer/password
19
+ ```
20
+
21
+ </td>
22
+ <td>
11
23
 
24
+ ```sh
12
25
  yarn add @inquirer/password
13
26
  ```
14
27
 
28
+ </td>
29
+ </tr>
30
+ </table>
31
+
15
32
  # Usage
16
33
 
17
34
  ```js
@@ -26,7 +43,7 @@ const answer = await password({ message: 'Enter your name' });
26
43
  | -------- | ----------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
27
44
  | message | `string` | yes | The question to ask |
28
45
  | mask | `boolean` | no | Show a `*` mask over the input or keep it transparent |
29
- | 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. |
46
+ | validate | `string => boolean \| string \| Promise<boolean \| string>` | 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. |
30
47
  | theme | [See Theming](#Theming) | no | Customize look of the prompt. |
31
48
 
32
49
  ## Theming
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@inquirer/password",
3
- "version": "2.1.11",
3
+ "version": "2.1.13",
4
4
  "engines": {
5
5
  "node": ">=18"
6
6
  },
@@ -57,12 +57,12 @@
57
57
  "license": "MIT",
58
58
  "homepage": "https://github.com/SBoudrias/Inquirer.js/blob/master/packages/password/README.md",
59
59
  "dependencies": {
60
- "@inquirer/core": "^8.2.4",
61
- "@inquirer/type": "^1.3.3",
60
+ "@inquirer/core": "^9.0.1",
61
+ "@inquirer/type": "^1.4.0",
62
62
  "ansi-escapes": "^4.3.2"
63
63
  },
64
64
  "devDependencies": {
65
- "@inquirer/testing": "^2.1.23"
65
+ "@inquirer/testing": "^2.1.25"
66
66
  },
67
67
  "scripts": {
68
68
  "tsc": "yarn run tsc:esm && yarn run tsc:cjs",
@@ -87,5 +87,5 @@
87
87
  }
88
88
  },
89
89
  "sideEffects": false,
90
- "gitHead": "d5f62c6ee3e671f7d1b776b85d43781869d70918"
90
+ "gitHead": "2285f2c043448ff4317635cf6481df7ffda2d3bd"
91
91
  }