https://github.com/doowb/ask-once
Only ask a question one time and store the answer.
https://github.com/doowb/ask-once
Last synced: about 2 months ago
JSON representation
Only ask a question one time and store the answer.
- Host: GitHub
- URL: https://github.com/doowb/ask-once
- Owner: doowb
- License: mit
- Created: 2015-08-07T21:04:26.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-10-24T05:17:15.000Z (over 9 years ago)
- Last Synced: 2025-03-08T07:03:39.278Z (about 2 months ago)
- Language: JavaScript
- Size: 270 KB
- Stars: 10
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ask-once [](http://badge.fury.io/js/ask-once) [](https://travis-ci.org/doowb/ask-once)
> Only ask a question one time and store the answer.
## Install
Install with [npm](https://www.npmjs.com/)
```sh
$ npm i ask-once --save
```
## Usage
```js
var ask = require('ask-once')();
```
**Ask a question**
```js
ask.once('May I have your username?', function (err, answer) {
console.log(answer);
});
```
The user's answer is saved, and the question won't be asked again unless:
* `force: true` is passed on the options, or
* the answer is deleted directly
## FAQ
**Where are the answers stored?**
The user's answers are saved on a global config store that is uniquely identified to the application using `ask-once`.
**Can I change where answers are stored?**
Yes, you can pass the name of a [data-store](https://github.com/jonschlinkert/data-store) with the `cwd` option set to whatever you want it to be. Here's an example:
```js
// pass the name of a data-store, so you can use
// whatever storage location you want
var ask = require('ask-once')({
store: {
name: 'foo',
cwd: 'bar'
}
});
ask.once('May I have your username?' function (err, answer) {
console.log(answer);
});
```
## Docs
### options
> To re-ask questions or reset the stored values:
* `options.force`: will re-ask the given question or questions, regardless of whether or not previously stored values exists.
* `options.init`: will **delete the entire store** and start over again.
### API
### [Ask](index.js#L27)
Returns a question-asking function that only asks a question if the answer is not already stored, or if forced.
**Params**
* `options` **{Object}**
* `options.questions` **{Object}**: (optional) Options to be passed to [question-cache](https://github.com/jonschlinkert/question-cache)
* `options.store` **{Object}**: (optional) Options to be passed to [data-store](https://github.com/jonschlinkert/data-store)
**Example**
```js
var ask = new Ask({questions: questions});
```
### [.set](index.js#L64)
Set answer `key` with the given `value`. Answers are cached in memory on the `ask.answers.data` object, and they are also persisted to disk.
**Params**
* `key` **{String}**
**Example**
```js
ask.set('a', 'b');
console.log(ask.answers.data.a)
//=> 'b'
```
### [.get](index.js#L81)
Get answer `key` from the answer store.
**Params**
* `key` **{String}**
**Example**
```js
ask.set('a', 'b');
ask.get('a');
//=> 'b'
```
### [.del](index.js#L98)
Delete an answer from the answer store.
**Params**
* `key` **{String|Array|Object}**: Pass a string or array of keys, or `{force: true}` to wipe out the entire store.
**Example**
```js
ask.del('foo');
ask.del(['foo', 'bar']);
// delete the entire store
ask.del({force: true});
```
### [.once](index.js#L114)
Ask a question only if the answer is not already stored. If
the answer is passed on the options the question is bypassed
and the answer is be returned.
**Params**
* `question` **{String}**: Key of the question to ask.
* `options` **{Object}**: Answers or options to force re-asking questions.
* `cb` **{Function}**: Callback function with `err` and `answer`.
## Examples
First time the program is run, the user is prompted to answer a question:
[](https://www.npmjs.com/)
Additional runs of the program will skip prompting the user:
[](https://github.com/jonschlinkert/data-store)
Passing the `init` option will delete all the stored answers and prompt the user to answer the question again:
[](index.js#L27)
Additional runs after clearing the stop will return the newly saved answer:
[](https://github.com/jonschlinkert/question-cache)
Passing the `force` option will force the question to be asked:
[](https://github.com/jonschlinkert/data-store)
Additional runs after forcing the question, will return the newly saved answer:
[](index.js#L64)
## Related projects
* [data-store](https://www.npmjs.com/package/data-store): Easily get, set and persist config data. | [homepage](https://github.com/jonschlinkert/data-store)
* [inquirer](https://www.npmjs.com/package/inquirer): A collection of common interactive command line user interfaces. | [homepage](https://github.com/sboudrias/Inquirer.js#readme)
* [question-cache](https://www.npmjs.com/package/question-cache): A wrapper around inquirer that makes it easy to create and selectively reuse questions. | [homepage](https://github.com/jonschlinkert/question-cache)
* [question-helper](https://www.npmjs.com/package/question-helper): Template helper that asks a question in the command line and resolves the template with… [more](https://www.npmjs.com/package/question-helper) | [homepage](https://github.com/doowb/question-helper)
## Running tests
Install dev dependencies:
```sh
$ npm i -d && npm test
```
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/doowb/ask-once/issues/new).
## Author
**Brian Woodward**
+ [github/doowb](https://github.com/doowb)
+ [twitter/doowb](http://twitter.com/doowb)
## License
Copyright © 2015 Brian Woodward
Released under the MIT license.
***
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on October 24, 2015._