Home

Awesome

ask-once NPM version Build Status

Only ask a question one time and store the answer.

Install

Install with npm

$ npm i ask-once --save

Usage

var ask = require('ask-once')();

Ask a question

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:

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 with the cwd option set to whatever you want it to be. Here's an example:

// 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:

API

Ask

Returns a question-asking function that only asks a question if the answer is not already stored, or if forced.

Params

Example

var ask = new Ask({questions: questions});

.set

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

Example

ask.set('a', 'b');
console.log(ask.answers.data.a)
//=> 'b'

.get

Get answer key from the answer store.

Params

Example

ask.set('a', 'b');
ask.get('a');
//=> 'b'

.del

Delete an answer from the answer store.

Params

Example

ask.del('foo');
ask.del(['foo', 'bar']);
// delete the entire store
ask.del({force: true});

.once

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

Examples

First time the program is run, the user is prompted to answer a question:

image

Additional runs of the program will skip prompting the user:

image

Passing the init option will delete all the stored answers and prompt the user to answer the question again:

image

Additional runs after clearing the stop will return the newly saved answer:

image

Passing the force option will force the question to be asked:

image

Additional runs after forcing the question, will return the newly saved answer:

image

Related projects

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Brian Woodward

License

Copyright © 2015 Brian Woodward Released under the MIT license.


This file was generated by verb-cli on October 24, 2015.