xprompt

0.0.1 • Public • Published

prompts

Minimal interactive command-line prompts

Installation

$ npm install xprompt

Example

Single Prompt

Prompt with a single prompt object. Returns object with the response.

const prompts = require('xprompt');
 
(async () => {
  const response = await prompts({
    type: 'input',
    name: 'age',
    message: 'How old are you?',
  });
 
  console.log(response); // => { age: '24' }
})();
 

Prompt Chain

Prompt with a list of prompt objects. Returns object with response. Make sure to give each prompt a unique name property to prevent overwriting values.

const Prompts = require('xprompt');
 
const questions = [
  {
    type: 'input',
    name: 'username',
    message: 'Type your username:',
  },
  {
    type: 'hidden',
    name: 'password',
    message: 'Type your password:',
  },
  {
    type: 'confirm',
    name: 'pizza',
    message: 'Do you like pizza ?'
  },
  {
    type: 'select',
    name: 'color',
    message: 'Pick a color:',
    menu: [
      'Red',
      'Green',
      'Blue'
    ]
  }
];
 
const prompts = new Prompts({
  prefix: '[Prompts]',
  underline: true
});
 
prompts.prompt(questions).then(console.log);

API

  • new Prompts(options?: Object)
  • prompts(questions: Array | Object, options?: Object): Promise
  • prompts.text(prompt: Object): Promise
  • prompts.hidden(prompt: Object): Promise
  • prompts.confirm(prompt: Object): Promise
  • prompts.select(prompt: Object): Promise
  • prompts.keypress(prompt: Object): Promise

Contributing

  • Fork this Repo first
  • Clone your Repo
  • Install dependencies by $ npm install
  • Checkout a feature branch
  • Feel free to add your features
  • Make sure your features are fully tested
  • Publish your local branch, Open a pull request
  • Enjoy hacking <3

MIT

This work is licensed under the MIT license.


Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 0.0.1
    2
    • latest

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 0.0.1
    2
  • 0.0.0
    0

Package Sidebar

Install

npm i xprompt

Weekly Downloads

2

Version

0.0.1

License

MIT

Unpacked Size

175 kB

Total Files

29

Last publish

Collaborators

  • song940