# inquirer-promise

> Promise-based shortcuts for inquirer

Latest version **1.0.0** (published 2016-10-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install inquirer-promise
pnpm add inquirer-promise
yarn add inquirer-promise
bun add inquirer-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.0 |
| Published | 2016-10-13 |
| First published | 2016-01-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Olivier Breuleux |
| Maintainers | breuleux |

## Links

- npm: https://www.npmjs.com/package/inquirer-promise
- Repository: https://github.com/breuleux/inquirer-promise
- Homepage: https://github.com/breuleux/inquirer-promise#readme
- Issues: https://github.com/breuleux/inquirer-promise/issues
- npm.io page: https://npm.io/package/inquirer-promise

## Dependencies (1)

- [inquirer](https://npm.io/package/inquirer.md) ^1.2.1

## Recent versions

- 1.0.0 (latest) — 2016-10-13
- 0.0.3 — 2016-01-25
- 0.0.2 — 2016-01-25
- 0.0.1 — 2016-01-25
- 0.0.0 — 2016-01-25

## README

inquirer-promise
================

Promise wrapper around `inquirer`.

## prompt

```javascript
inquirer = require("inquirer-promise");

inquirer.prompt([{type: "input",
                  name: "animal",
                  message: "Favorite animal?",
                  default: "wapiti"}])
  .then(results => console.log(results.animal));
```

## question

Ask one question.

```javascript
inquirer.question({type: "input",
                   message: "Favorite animal?",
                   default: "wapiti"})
  .then(animal => console.log(animal));
```

## input

```javascript
inquirer.input("Favorite animal?", {default: "wapiti"})
  .then(animal => console.log(animal));
```

## confirm

```javascript
inquirer.confirm("Is the wapiti your favorite animal?")
  .then(answer => console.log(answer));
```

## list

```javascript
inquirer.list("Favorite animal?", ["cat", "dog", "wapiti"])
  .then(animal => console.log(animal));
```

## rawlist

```javascript
inquirer.rawlist("Favorite animal?", ["cat", "dog", "wapiti"])
  .then(animal => console.log(animal));
```

## expand

```javascript
inquirer.expand("Favorite animal?",
                [{key: "c", name: "cat"}
                 {key: "d", name: "dog"}
                 {key: "w", name: "wapiti"}])
  .then(animal => console.log(animal));
```

## checkbox

```javascript
inquirer.checkbox("Favorite animals?", ["cat", "dog", "wapiti"])
  .then(animals => console.log(animals));
```

## password

```javascript
inquirer.password("Enter password.")
  .then(password => console.log("Don't print passwords!"));
```

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