# string-progressbar

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

Latest version **1.0.4** (published 2021-05-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install string-progressbar
pnpm add string-progressbar
yarn add string-progressbar
bun add string-progressbar
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2021-05-07 |
| First published | 2020-08-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 29 |
| Author | Sparker |
| Maintainers | sparker-99 |
| Keywords | discord, discord.js, eris, progress, bar, progress bar |

## Links

- npm: https://www.npmjs.com/package/string-progressbar
- Repository: https://github.com/Sparker-99/string-progressbar
- Homepage: https://github.com/Sparker-99/string-progressbar#readme
- Issues: https://github.com/Sparker-99/string-progressbar/issues
- npm.io page: https://npm.io/package/string-progressbar

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 1.0.4 (latest) — 2021-05-07
- 1.0.3 — 2021-01-25
- 1.0.2 — 2021-01-23
- 1.0.1 — 2020-08-03

## README

<div align="center">
  <br />
  <p>
    <a href="https://www.npmjs.com/package/string-progressbar"><img src="https://i.ibb.co/HHXtHf3/string-progressbar.png" width="546" alt="progressbar" /></a>

  </p>
  <br />
  <p>
    <a href="https://discord.gg/tGkbpCD"><img src="https://discord.com/api/guilds/389745592232050688/embed.png" alt="Discord server" /></a> <a href="https://www.npmjs.com/package/string-progressbar"><img src="https://img.shields.io/npm/dt/string-progressbar.svg?maxAge=3600" alt="NPM downloads" /></a>

</p>
</div>

## About

**String Progressbar** is a customizable progress bar generator manily made for discord bots that are made in [Discord.js](https://discord.js.org/) and [Eris](https://abal.moe/Eris/). It generates string so its pretty much usable everywhere.

## Advantages

* Simple
* Lightweight
* Fully customizable
* 2 Different Styles

 ## Installation

``` sh
npm install string-progressbar
```

 ## Splitbar Usage
 
![](https://i.ibb.co/5Yz89gM/splitbar.png)

``` js
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
 
![](https://i.ibb.co/ctTB8mp/filledbar.png)

``` js
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|


## Links

* [Discord Support](https://discord.gg/tGkbpCD)
* [Npm package](https://www.npmjs.com/package/string-progressbar)

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

This project is [MIT](https://github.com/sparker-99/string-progressbar/blob/master/LICENSE) licensed.

---
_Source: https://npm.io/package/string-progressbar · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._