@joegesualdo/multi-prompt-node

multi-prompt

Multiple command line prompts.

Install

$ npm install --save @joegesualdo/multi-prompt-node

Usage

import MultiPrompt from '@joegesualdo/multi-prompt-node';

const questions = [
  {
    prompt: `What's your name?`,
  },
  {
    prompt: `How old are you?`,
  },
]

new MultiPrompt(questions)
.on('done', result => {
  console.log(result)
})
.begin()

Test

$ npm test

API

MultiPrompt(prompts, [options])

Instantiates a new prompt

Params

Name	Type	Default	Description
prompts	Array<Object>	[]	An object representing properties of a prompt
options	Object	{}	Configuration options

Example Promp Object:

{
  identifier: 'who',
  prompt: ` Where do you live?`,
  dependent: {
    question: 'language',
    answers: [
      'ruby'
    ]
  },
  validation: (answer) => {
    return ['node', 'ruby'].indexOf(answer) !== -1;
  }
  onDone: (answer) => {
    return 'I am no one :-)'
  }
}

Options

Name	Type	Default	Description
indent	Number	2	How many spaces do you want the prompts to be indented

Returns: multiPrompt

multiPrompt.begin()

Starts the prompt

import MultiPrompt from '@joegesualdo/multi-prompt-node'

const questions = [
  {
    prompt: `What's your name?`,
  },
  {
    prompt: `How old are you?`,
  },
]

new MultiPrompt(questions, {
  indent: 4,
})
.on('done', result=> {
  console.log(result)
})
.begin()

multiPrompt.on(type, fn)

Sets lifecycle methods

Params

Name	Type	Default	Description	Possible values
type	String	N/A	The lifecycle name	done
fn	Function	N/A	Function to run	N/A

import MultiPrompt from '@joegesualdo/multi-prompt-node'

const questions = [
  {
    prompt: `What's your name?`,
  },
  {
    prompt: `How old are you?`,
  },
]

new MultiPrompt(questions)
.on('done', result=> {
  console.log(result)
})
.begin()

Build

$ npm run build

Related

• prompt-node - Command line prompt

License

MIT Joe Gesualdo