# prompt-promise

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

Latest version **1.0.3** (published 2015-01-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install prompt-promise
pnpm add prompt-promise
yarn add prompt-promise
bun add prompt-promise
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2015-01-31 |
| First published | 2014-12-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13 |
| Author | Charlike Make Reagent |
| Maintainers | tunnckocore |
| Keywords | 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 |

## Links

- npm: https://www.npmjs.com/package/prompt-promise
- Repository: https://github.com/tunnckoCore/prompt-promise
- Issues: https://github.com/tunnckoCore/prompt-promise/issues
- npm.io page: https://npm.io/package/prompt-promise

## Dependencies (2)

- [keypress](https://npm.io/package/keypress.md) ~0.2.1
- [native-or-another](https://npm.io/package/native-or-another.md) ~2.0.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2015-01-31
- 1.0.2 — 2014-12-21
- 1.0.1 — 2014-12-21
- 1.0.0 — 2014-12-21
- 0.0.0 — 2014-12-20

## README

## [![npm][npmjs-img]][npmjs-url] [![mit license][license-img]][license-url] [![build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url] [![deps status][daviddm-img]][daviddm-url]

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

## Install
```
npm i --save prompt-promise
```

## Run examples
```
npm run with-co
npm run without-co
```

## Usage
> For more use-cases see [examples](./examples)

```js
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**
+ [gratipay/tunnckoCore][author-gratipay]
+ [twitter/tunnckoCore][author-twitter]
+ [github/tunnckoCore][author-github]
+ [npmjs/tunnckoCore][author-npmjs]
+ [more ...][contrib-more]


## License [![MIT license][license-img]][license-url]
Copyright (c) 2014-2015 [Charlike Mike Reagent][contrib-more], [contributors][contrib-graf].   
Copyright (c) 2014 [TJ Holowaychuk](https://github.com/tj), [contributors][contrib-graf].  
Released under the [`MIT`][license-url] license.


[npmjs-url]: http://npm.im/prompt-promise
[npmjs-img]: https://img.shields.io/npm/v/prompt-promise.svg?style=flat&label=prompt-promise

[coveralls-url]: https://coveralls.io/r/tunnckoCore/prompt-promise?branch=master
[coveralls-img]: https://img.shields.io/coveralls/tunnckoCore/prompt-promise.svg?style=flat

[license-url]: https://github.com/tunnckoCore/prompt-promise/blob/master/license.md
[license-img]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat

[travis-url]: https://travis-ci.org/tunnckoCore/prompt-promise
[travis-img]: https://img.shields.io/travis/tunnckoCore/prompt-promise.svg?style=flat

[daviddm-url]: https://david-dm.org/tunnckoCore/prompt-promise
[daviddm-img]: https://img.shields.io/david/tunnckoCore/prompt-promise.svg?style=flat

[author-gratipay]: https://gratipay.com/tunnckoCore
[author-twitter]: https://twitter.com/tunnckoCore
[author-github]: https://github.com/tunnckoCore
[author-npmjs]: https://npmjs.org/~tunnckocore

[contrib-more]: http://j.mp/1stW47C
[contrib-graf]: https://github.com/tunnckoCore/prompt-promise/graphs/contributors

***

_Powered and automated by [kdf](https://github.com/tunnckoCore), January 31, 2015_

[co]: https://github.com/tj/co

---
_Source: https://npm.io/package/prompt-promise · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._