You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

32 lines
774 B

  1. ## getpass
  2. Get a password from the terminal. Sounds simple? Sounds like the `readline`
  3. module should be able to do it? NOPE.
  4. ## Install and use it
  5. ```bash
  6. npm install --save getpass
  7. ```
  8. ```javascript
  9. const mod_getpass = require('getpass');
  10. ```
  11. ## API
  12. ### `mod_getpass.getPass([options, ]callback)`
  13. Gets a password from the terminal. If available, this uses `/dev/tty` to avoid
  14. interfering with any data being piped in or out of stdio.
  15. This function prints a prompt (by default `Password:`) and then accepts input
  16. without echoing.
  17. Parameters:
  18. * `options`, an Object, with properties:
  19. * `prompt`, an optional String
  20. * `callback`, a `Func(error, password)`, with arguments:
  21. * `error`, either `null` (no error) or an `Error` instance
  22. * `password`, a String