Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

prompt-promise

tunnckoCore20.1kMIT1.0.3

Sane CLI user-input (command prompt, confirm, multiline, password) as promises, it can be used with co@4

aplus, cli, co, cojs, command, command-line, command-prompt, confirm, console, esnext, generators, input, keypress, line, mask, minimal, multiline, password, pretty, promises, promises-aplus, prompt, prompts, sane, terminal, tiny, unobtrusive, user, user-input

readme

npm mit license build status coverage status deps status

Sane CLI user-input (command prompt, confirm, multiline, password) as promises, it can be used with co@4

Install

npm i --save prompt-promise

Run examples

npm run with-co
npm run without-co

Usage

For more use-cases see examples

var co = require('co');
var prompt = require('prompt-promise');
var res = [];

prompt('username: ')
.then(function username(val) {
  res.push(val);
  return prompt.password('password: ');
})
.then(function pasword(val) {
  res.push(val);
  console.log(res);
  prompt.done();
})
.catch(function rejected(err) {
  console.log('error:', err.stack);
  prompt.finish();
});

// or with `co@4`
co(function * genPrompt() {
  var username = yield prompt('username: ');
  var password = yield prompt.password('password: ');

  return yield [username, password];
})
.then(function fulfilled(array) {
  console.log('response:', array);
  prompt.end();
})
.catch(function rejected(err) {
  console.log('error:', err.stack);
  process.stdin.pause();
});

.end(), .done(), .finish() are just aliases for process.stdin.pause(); its required, nah..

Author

Charlike Mike Reagent

License MIT license

Copyright (c) 2014-2015 Charlike Mike Reagent, contributors.
Copyright (c) 2014 TJ Holowaychuk, contributors.
Released under the MIT license.


Powered and automated by kdf, January 31, 2015

changelog

v1.0.3 / January 31, 2015

  • Release v1.0.3 / npm@v1.0.3
  • update dotfiles
  • update license year
  • update scripts
  • update without-co example
  • add badges
  • update usage example
  • update deps versions ranges

v1.0.2 / December 21, 2014

  • Release v1.0.2 / npm@v1.0.2
  • forgot to add bluebird in devDeps

v1.0.1 / December 21, 2014

v1.0.0 / December 21, 2014

v0.0.0 / December 20, 2014

  • init commits