# enquirer-question

> Question object, used by Enquirer and prompt plugins.

Latest version **0.3.0** (published 2016-08-30) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install enquirer-question
pnpm add enquirer-question
yarn add enquirer-question
bun add enquirer-question
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2016-08-30 |
| First published | 2016-08-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | answer, answers, ask, bar, bottom, checkbox, choice, cli, command, enquirer, input, inquire, inquirer, interact, list, menu, password, prompt, prompts, question, readline, stdin, stdout, terminal, tty, ui |

## Links

- npm: https://www.npmjs.com/package/enquirer-question
- Repository: https://github.com/enquirer/enquirer-question
- Issues: https://github.com/enquirer/enquirer-question/issues
- npm.io page: https://npm.io/package/enquirer-question

## Dependencies (6)

- [kind-of](https://npm.io/package/kind-of.md) ^3.0.4
- [clone-deep](https://npm.io/package/clone-deep.md) ^0.2.4
- [lazy-cache](https://npm.io/package/lazy-cache.md) ^2.0.1
- [extend-shallow](https://npm.io/package/extend-shallow.md) ^2.0.1
- [prompt-choices](https://npm.io/package/prompt-choices.md) ^0.3.0
- [define-property](https://npm.io/package/define-property.md) ^0.2.5

## 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

- 0.3.0 (latest) — 2016-08-30
- 0.2.1 — 2016-08-30
- 0.2.0 — 2016-08-30
- 0.1.2 — 2016-08-29
- 0.1.1 — 2016-08-29
- 0.1.0 — 2016-08-29

## README

# enquirer-question [![NPM version](https://img.shields.io/npm/v/enquirer-question.svg?style=flat)](https://www.npmjs.com/package/enquirer-question) [![NPM downloads](https://img.shields.io/npm/dm/enquirer-question.svg?style=flat)](https://npmjs.org/package/enquirer-question) [![Build Status](https://img.shields.io/travis/enquirer/enquirer-question.svg?style=flat)](https://travis-ci.org/enquirer/enquirer-question)

> Question object, used by Enquirer and prompt plugins.

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install --save enquirer-question
```

## Usage

The main export is a constructor function that is used to create new `Question` objects, which are used in prompts by [enquirer](https://github.com/jonschlinkert/enquirer).

```js
var Question = require('enquirer-question');
var question = new Question('color', 'What is favorite color?');
```

**Examples**

Any of the following signatures may be used:

```js
var question = new Question('color'); // sets message as the same value as `name`
var question = new Question('color', 'What is favorite color?');
var question = new Question('color', {message: 'What is favorite color?'});
var question = new Question({name: 'color', message: 'What is favorite color?'});
var question = new Question({name: 'color'});
```

## About

### Related projects

* [choices-separator](https://www.npmjs.com/package/choices-separator): Separator for choices arrays in prompts. Based on the Separator from inquirer. | [homepage](https://github.com/enquirer/choices-separator "Separator for choices arrays in prompts. Based on the Separator from inquirer.")
* [enquirer](https://www.npmjs.com/package/enquirer): Plugin-based prompt system for node.js | [homepage](https://github.com/jonschlinkert/enquirer "Plugin-based prompt system for node.js")
* [prompt-choices](https://www.npmjs.com/package/prompt-choices): Create an array of multiple choice objects for use in prompts. | [homepage](https://github.com/enquirer/prompt-choices "Create an array of multiple choice objects for use in prompts.")
* [readline-utils](https://www.npmjs.com/package/readline-utils): Readline utils, for moving the cursor, clearing lines, creating a readline interface, and more. | [homepage](https://github.com/enquirer/readline-utils "Readline utils, for moving the cursor, clearing lines, creating a readline interface, and more.")

### Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

Please read the [contributing guide](contributing.md) for avice on opening issues, pull requests, and coding standards.

### Building docs

_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_

To generate the readme and API documentation with [verb](https://github.com/verbose/verb):

```sh
$ npm install -g verb verb-generate-readme && verb
```

### Running tests

Install dev dependencies:

```sh
$ npm install -d && npm test
```

### Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

### License

Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/enquirer/enquirer-question/blob/master/LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.30, on August 30, 2016._

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