# percentagebar

> Package to get a percentageBar inform of a String

Latest version **1.0.3** (published 2019-04-27) · ISC license · 0 weekly downloads

## Install

```sh
npm install percentagebar
pnpm add percentagebar
yarn add percentagebar
bun add percentagebar
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2019-04-27 |
| First published | 2019-04-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 15.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | plasmachicken |
| Maintainers | plasmachicken |
| Keywords | string, progress, progressbar, bar, status, statusbar, utility, widget |

## Links

- npm: https://www.npmjs.com/package/percentagebar
- Repository: https://github.com/PLASMAchicken/percentagebar
- Homepage: https://github.com/PLASMAchicken/percentagebar#readme
- Issues: https://github.com/PLASMAchicken/percentagebar/issues
- npm.io page: https://npm.io/package/percentagebar

## 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.3 (latest) — 2019-04-27
- 1.0.2 — 2019-04-19
- 1.0.1 — 2019-04-17
- 1.0.0 — 2019-04-17

## README

# percentagebar

# Example
```js
const percentagebar = require('percentagebar')
percentagebar(10, 5); // returns ==> '[▓▓▓▓▓░░░░░] 50%'
```
![Example](/example.png)


# Documentation
<a name="statusbar"></a>

## statusbar(full, curr, [length], [highChar], [lowChar], [openingChar], [closingChar], [addPercent]) ⇒ <code>string</code>
Function to return a process Bar.

**Kind**: global function  
**Returns**: <code>string</code> - - Process Bar.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| full | <code>number</code> |  | Full Value. |
| curr | <code>number</code> |  | Current Value. |
| [length] | <code>number</code> | <code>10</code> | Length of the Process Bar. |
| [highChar] | <code>string</code> | <code>&quot;▓&quot;</code> | Char to use when prercent high. |
| [lowChar] | <code>string</code> | <code>&quot;░&quot;</code> | Char to use when percent low. |
| [openingChar] | <code>string</code> | <code>&quot;[&quot;</code> | Char to use to open percentage Bar. |
| [closingChar] | <code>string</code> | <code>&quot;]&quot;</code> | Char to use to close percentage bar. |
| [addPercent] | <code>boolean</code> | <code>true</code> | Option to add Percent after Bar. : [▓▓] 100%. |

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