Git Product home page Git Product logo

prompt-for's Introduction

prompt-for

Prompt the user for a series of answers.

Installation

$ npm install prompt-for

Example

var prompt = require('prompt-for');

var schema = {
  name: 'string',
  siblings: 'number',
  birthday: 'date',
  deceased: 'boolean',
  secret: 'password'
};

prompt(schema, function(err, answers){
  assert(answers.name == 'Ian');
  assert(answers.siblings == 2);
  assert(answers.birthday.getTime() == 1343260800000);
  assert(answers.deceased == false);
  assert(answers.secret == '1234');
});

And if you're being lazy...

prompt(['name', 'website'], function(err, answers){
  assert(answers.name == 'Ian');
  assert(answers.website == 'ianstormtaylor.com');
});

Or even...

prompt('name', function(err, answers){
  assert(answers.name == 'Ian');
});

Options

Define or overwrite default values...

  • Default boolean value is false
  • Default date value is now
var prompt = require('prompt-for');

var schema = {
  name: {type:'string', default:'Ian'},
  siblings: {type:'number', default:42},
  birthday: {type:'date', default:'yesterday'},
  deceased: {type:'boolean', default:true},
  secret: {type:'password', default:'1234'}
};

prompt(schema, function(err, answers){
  assert(answers.name == 'Ian');
  // ...
});

Disable required for string and number...

By default, empty or incorrect answers when asked a string or a number, will be asked again. Set required to false allows you to skip the question.

var prompt = require('prompt-for');

var schema = {
  name: {type:'string', required:false},
  siblings: {type:'number', required:false}
};

prompt(schema, function(err, answers){
  assert(answers.name == null);
  assert(answers.number == null);
});

API

prompt(schema, [options], fn)

Prompt the user with the given schema and optional options, then callback with fn(err, answers). Options default to:

{
  color: null,
  pad: true,
  prefix: '',
  separator: ': '
}

License

MIT

prompt-for's People

Contributors

ianstormtaylor avatar jeromedecoster avatar yyx990803 avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.