Skip to content
This repository has been archived by the owner on Jan 8, 2025. It is now read-only.

Commit

Permalink
docs: update example
Browse files Browse the repository at this point in the history
The previous example seems to incorrectly imply that the return value is a string.
Change the snippet to use promise handling.
  • Loading branch information
zypA13510 authored Mar 1, 2021
1 parent 8c65afe commit eab0f5b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ let read = {
* @module password-prompt
* @example
* let prompt = require('password-prompt')
* let password = prompt('password: ')
* let password = await prompt('password: ')
* // password: ******
* @param {string} [ask] - prompt output
* @param {Object} [options]
Expand Down

0 comments on commit eab0f5b

Please sign in to comment.