@topcli/prompts 1.0.0 → 1.0.1

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 (3) hide show
  1. package/README.md +22 -1
  2. package/index.d.ts +1 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -91,7 +91,7 @@ Use `ignoreValues` to skip result render & clear lines after a selected one.
91
91
  ### `confirm()`
92
92
 
93
93
  ```ts
94
- confirm(message: string, options?: ConfirmOptions): Promise<string>
94
+ confirm(message: string, options?: ConfirmOptions): Promise<boolean>
95
95
  ```
96
96
 
97
97
  Boolean prompt, return `options.initial` if user input is different from "y"/"yes"/"n"/"no", (default `false`).
@@ -127,3 +127,24 @@ export interface ConfirmOptions {
127
127
  initial?: boolean = false;
128
128
  }
129
129
  ```
130
+
131
+ ## Contributors
132
+
133
+ <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
134
+ <!-- prettier-ignore-start -->
135
+ <!-- markdownlint-disable -->
136
+ <table>
137
+ <tbody>
138
+ <tr>
139
+ <td align="center" valign="top" width="14.28%"><a href="https://github.com/PierreDemailly"><img src="https://avatars.githubusercontent.com/u/39910767?v=4?s=100" width="100px;" alt="PierreDemailly"/><br /><sub><b>PierreDemailly</b></sub></a><br /><a href="https://github.com/TopCli/prompts/commits?author=PierreDemailly" title="Code">💻</a> <a href="https://github.com/TopCli/prompts/commits?author=PierreDemailly" title="Tests">⚠️</a></td>
140
+ <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/thomas-gentilhomme/"><img src="https://avatars.githubusercontent.com/u/4438263?v=4?s=100" width="100px;" alt="Gentilhomme"/><br /><sub><b>Gentilhomme</b></sub></a><br /><a href="https://github.com/TopCli/prompts/pulls?q=is%3Apr+reviewed-by%3Afraxken" title="Reviewed Pull Requests">👀</a></td>
141
+ <td align="center" valign="top" width="14.28%"><a href="http://tonygo.dev"><img src="https://avatars0.githubusercontent.com/u/22824417?v=4?s=100" width="100px;" alt="Tony Gorez"/><br /><sub><b>Tony Gorez</b></sub></a><br /><a href="https://github.com/TopCli/prompts/pulls?q=is%3Apr+reviewed-by%3Atony-go" title="Reviewed Pull Requests">👀</a></td>
142
+ <td align="center" valign="top" width="14.28%"><a href="http://sofiand.github.io/portfolio-client/"><img src="https://avatars.githubusercontent.com/u/39944043?v=4?s=100" width="100px;" alt="Yefis"/><br /><sub><b>Yefis</b></sub></a><br /><a href="https://github.com/TopCli/prompts/commits?author=SofianD" title="Code">💻</a> <a href="https://github.com/TopCli/prompts/commits?author=SofianD" title="Documentation">📖</a></td>
143
+ </tr>
144
+ </tbody>
145
+ </table>
146
+
147
+ <!-- markdownlint-restore -->
148
+ <!-- prettier-ignore-end -->
149
+
150
+ <!-- ALL-CONTRIBUTORS-LIST:END -->
package/index.d.ts CHANGED
@@ -25,6 +25,6 @@ export interface ConfirmOptions {
25
25
 
26
26
  export function question(message: string, options?: PromptOptions): Promise<string>;
27
27
  export function select(message: string, options: SelectOptions): Promise<string>;
28
- export function confirm(message: string, options?: ConfirmOptions): Promise<string>;
28
+ export function confirm(message: string, options?: ConfirmOptions): Promise<boolean>;
29
29
 
30
30
  export function required(): Validator;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@topcli/prompts",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Node.js user input library for command-line interfaces.",
5
5
  "scripts": {
6
6
  "test": "node --loader=esmock --test ./test/**.test.js",