Promptly sync

Promptly sync is a simple commandline prompting tool using promptly.

Installation

npm install promptly-sync

Usage

var questions = [{
    name: 'name',
    type: 'prompt',
    description: 'Enter an username'
}, {
    name: 'password',
    type: 'password',
    description: 'Password for login'
}, {
    name: 'email',
    type: 'prompt',
    description: 'Enter an email'
}];

var promptlySync = require('promptly-sync');
promptlySync(questions, function(err, result) {
    console.log(result);
});

//Result may looks like:
{
    name: 'Andi',
    password: '123456',
    email: '[email protected]'
}

See Promptly documentation for more infos about promptly.

Options

name        Set a property name

type        Set prompt type. Could be 'prompt', 'confirm',
            'password' or 'choose'. Defaults to 'prompt'

values      Defines values for a 'choose' prompt
            Example: values: ['aa', 'bb', 'cc'],

default     The default value. If not supplied, the input is mandatory 

trim        Automatically trim the input 

validator   A validator or an array of validators. 

retry       Automatically retry if a validator fails 

silent      Do not print what the user types 

input       Input stream to read

output      Output streams to write 

API

promptlySynv.noColor = true; Dissable colorized output

promptlySync.promptly Returns promptly

promptlySync.prompt() Calls promptly.prompt

promptlySync.confirm() Calls promptly.confirm

promptlySync.password() Calls promptly.password

promptlySync.choose() Calls promptly.choose