Null Pointer Micromanagement

    choices-separator

    2.0.0 • Public • Published

    choices-separator NPM version NPM monthly downloads NPM total downloads Linux Build Status

    Separator for choices arrays in prompts. Based on the Separator from inquirer.

    Install

    Install with npm:

    $ npm install --save choices-separator

    Usage

    var Separator = require('choices-separator');
    var Prompt = require('prompt-checkbox');
     
    var prompt = new Prompt({
      message: 'Which do you prefer?',
      name: 'favorites',
      choices: [
        new Separator(' = Color = '),
        {name: 'red'},
        {name: 'yellow', checked: true },
        {name: 'blue'},
        new Separator(' = Shape = '),
        {name: 'circle'},
        {name: 'triangle'},
        {name: 'square'}
      ]
    });
     
    prompt.run()
      .then(function(answer) {
        console.log(answer)
      });

    API

    Separator

    Separator object, used in choices arrays in prompts, to create a visual break between sections. The default separator line is ──────── styled with ansi-dim.

    Params

    • options {String}: Optionally provide a custom line and or prefix to use.

    Example

    new Separator('----');
    new Separator({line: '----'})
    new Separator({line: '----', prefix: '    '});

    .raw

    Returns the separator.line stripped of ansi styling.

    • returns {String}

    Example

    var separator = new Separator();
    console.log(separator.raw());
    //=> '────────'

    .render

    Render separator.prefix plus separator.line.

    • returns {String}

    Example

    var separator = new Separator();
    console.log(separator.render());
    //=> ' \u001b[2m────────\u001b[22m\n')

    .exclude

    Returns false if the given object is a separator.

    Params

    • choice {Object}: object to test against
    • returns {Boolean}: Returns false if the given object is a separator

    .toString

    Stringify separator

    • returns {String}: Returns the separator.line string

    Attribution

    Originally inspired by the Separator class from Inquirer.

    About

    Related projects

    enquirer: Intuitive, plugin-based prompt system for node.js. Much faster and lighter alternative to Inquirer, with all… more | homepage

    Contributing

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

    Building docs

    (This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

    To generate the readme, run the following command:

    $ npm install -g verbose/verb#dev verb-generate-readme && verb

    Running tests

    Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

    $ npm install && npm test

    Author

    Jon Schlinkert

    License

    Copyright © 2017, Jon Schlinkert. Released under the MIT License.


    This file was generated by verb-generate-readme, v0.6.0, on May 17, 2017.

    Install

    npm i choices-separator

    DownloadsWeekly Downloads

    65,707

    Version

    2.0.0

    License

    MIT

    Last publish

    Collaborators

    • jonschlinkert