New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix OclifUX.ux.prompt() return type #538
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -120,9 +120,9 @@ function _prompt(name: string, inputOptions: Partial<IPromptOptions> = {}): Prom | |
* prompt for input | ||
* @param name - prompt text | ||
* @param options - @see IPromptOptions | ||
* @returns void | ||
* @returns Promise<string> | ||
*/ | ||
export function prompt(name: string, options: IPromptOptions = {}) { | ||
export function prompt(name: string, options: IPromptOptions = {}): Promise<string> { | ||
return config.action.pauseAsync(() => { | ||
return _prompt(name, options) | ||
}, chalk.cyan('?')) | ||
|
@@ -149,9 +149,9 @@ export function confirm(message: string): Promise<boolean> { | |
/** | ||
* "press anykey to continue" | ||
* @param message - optional message to display to user | ||
* @returns Promise<void> | ||
* @returns Promise<string> | ||
*/ | ||
export async function anykey(message?: string): Promise<void> { | ||
export async function anykey(message?: string): Promise<string> { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. My change has revealed that this code was broken. It was typed as returning void but actually it was returning a string. |
||
const tty = Boolean(process.stdin.setRawMode) | ||
if (!message) { | ||
message = tty ? | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will help with backwards compatability, in the case that typescript cannot infer T.