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

mena

v1.0.2

Published

A customizable progress bar for console applications.

Downloads

3

Readme

mena

Introduction

Mena is a dynamic progress bar class for Node.js console applications, offering customizable visual elements for real-time progress tracking. Ideal for CLI tools, it enhances user interaction with progress visualization.

::: tip Mena is designed for ease of use and customization, focusing on console progress display. For additional features or complex console UIs, consider specialized libraries. :::

Features

  • Customizable Progress Bar: Tailor the length, characters, and colors of the progress bar.
  • Real-time Updates: Dynamically update the progress bar in response to application events.
  • Color Support: Set different colors for complete and incomplete segments.
  • Ease of Use: Simple API for quick integration into Node.js applications.

Installation

Install Mena in your Node.js project via npm. Ensure your environment supports ESModule syntax for seamless integration. Run the following command:

npm install mena

Usage

To use Mena, import it into your Node.js project, create an instance, and utilize its methods to display and update the progress bar.

import Mena from 'mena';

const progressBar = new Mena();
progressBar.update(0.5, 'Processing...'); // Update the progress bar to 50%

API Reference

Constructor

  • Mena(options?: MenaOptions) - Initializes the progress bar with optional custom settings.

Methods

  • update(value: string | number, text?: string): void - Updates the progress bar or displays a message.

Interface: MenaOptions

The MenaOptions interface allows for customization of the progress bar. It includes the following optional properties:

  • barLength: number - Specifies the length of the progress bar.
  • completedChar: string - Character representing completed segments.
  • incompleteChar: string - Character representing incomplete segments.
  • barStartChar: string - Character to be used at the start of the progress bar.
  • barEndChar: string - Character to be used at the end of the progress bar.
  • completeCharColor: Color[] - Array of RGB colors for completed segments.
  • incompleteCharColor: Color[] - Array of RGB colors for incomplete segments.

Type: Color

Represents an RGB color as a tuple of three numbers [number, number, number].

Contributing

Contributions to Mena are welcome. This library is part of the toolx library.

License

Mena is open-sourced under the MIT license, suitable for both personal and commercial use.