Skip to content
This repository was archived by the owner on Feb 1, 2022. It is now read-only.

Add documentation for non-required prompt #284

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add documentation for non-required prompt #284

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ await cli.prompt('What is your two-factor token?', {type: 'mask'})
// mask input on keypress (before enter is pressed)
await cli.prompt('What is your password?', {type: 'hide'})

// prompt that isn't required, user can press enter and move onto the next prompt
await cli.prompt('(Optional) What is your email address?', {required: false})

// yes/no confirmation
await cli.confirm('Continue?')

Expand Down