Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

string-progressbar

Sparker-994.8kMIT1.0.4TypeScript support: included

A simple progress bar generator using total progress and current progress values

discord, discord.js, eris, progress, bar, progress bar

readme


progressbar


Discord server NPM downloads

About

String Progressbar is a customizable progress bar generator manily made for discord bots that are made in Discord.js and Eris. It generates string so its pretty much usable everywhere.

Advantages

  • Simple
  • Lightweight
  • Fully customizable
  • 2 Different Styles

    Installation

npm install string-progressbar

Splitbar Usage

const progressbar = require('string-progressbar');
// Assaign values to total and current values
var total = 100;
var current = 50;
// First two arguments are mandatory
progressbar.splitBar(total, current, [options]);
// Returns: Array<String, String>

Filledbar Usage

const progressbar = require('string-progressbar');
// Assaign values to total and current values
var total = 100;
var current = 50;
// First two arguments are mandatory
progressbar.filledBar(total, current, [options]);
// Returns: Array<String, String>

Optional Parameters

Parameter name Type Default Description
size Integer 40 Determines the length of the bar
line String ▬ and □ Determines the Static part of the bar
slider String 🔘 and ■ Determines the Progressive part of the bar

Show your support

Give a ⭐️ if this project helped you!

📝 License

This project is MIT licensed.