# progress-bar-formatter

> Progress bar formatter

Latest version **2.0.1** (published 2015-01-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install progress-bar-formatter
pnpm add progress-bar-formatter
yarn add progress-bar-formatter
bun add progress-bar-formatter
```

## 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 | 2.0.1 |
| Published | 2015-01-11 |
| First published | 2013-12-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Gabriel Llamas |
| Maintainers | gagle |
| Keywords | progress, bar, format |

## Links

- npm: https://www.npmjs.com/package/progress-bar-formatter
- Repository: https://github.com/gagle/node-progress-bar-formatter
- Issues: https://github.com/gagle/node-progress-bar-formatter/issues
- npm.io page: https://npm.io/package/progress-bar-formatter

## 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

- 2.0.1 (latest) — 2015-01-11
- 2.0.0 — 2015-01-11
- 1.0.0 — 2014-01-01
- 0.0.1 — 2013-12-17

## README

progress-bar-formatter
======================

#### Progress bar formatter ####

[![npm version][npm-version-image]][npm-url]
[![Travis][travis-image]][travis-url]
[![Coveralls][coveralls-image]][coveralls-url]

#### Example ####

```javascript
var ProgressBarFormatter = require('progress-bar-formatter');

var bar = new ProgressBarFormatter();
console.log (bar.format(0.4));
// ##########··············
```

<a name="formatter"></a>
__Formatter([options])__

Options:

- __complete__ - _String_  
  The character that shows completion progress. Default is `#`.
- __incomplete__ - _String_  
  The character that shows the remaining progress. Default is `·`.
- __length__ - _Number_  
  The length of the progress bar. Default is `24`.

<a name="formatter_format"></a>
__Formatter#format(progress) : String__

Formats the progress bar. `progress` is a number between 0 and 1.

[npm-version-image]: https://img.shields.io/npm/v/progress-bar-formatter.svg?style=flat
[npm-url]: https://npmjs.org/package/progress-bar-formatter
[travis-image]: https://img.shields.io/travis/gagle/node-progress-bar-formatter.svg?style=flat
[travis-url]: https://travis-ci.org/gagle/node-progress-bar-formatter
[coveralls-image]: https://img.shields.io/coveralls/gagle/node-progress-bar-formatter.svg?style=flat
[coveralls-url]: https://coveralls.io/r/gagle/node-progress-bar-formatter

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