npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

choices-separator

v2.0.0

Published

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

Downloads

187,087

Readme

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.