# @vimlet/commons-progress

> Cli progress display

Latest version **0.0.7** (published 2019-03-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @vimlet/commons-progress
pnpm add @vimlet/commons-progress
yarn add @vimlet/commons-progress
bun add @vimlet/commons-progress
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.7 |
| Published | 2019-03-14 |
| First published | 2019-03-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Vimlet |
| Maintainers | devsvimlet, lethevimlet |
| Keywords | download |

## Links

- npm: https://www.npmjs.com/package/@vimlet/commons-progress
- Repository: https://github.com/vimlet/VimletCommons
- Homepage: https://github.com/vimlet/VimletCommons#readme
- Issues: https://github.com/vimlet/VimletCommons/issues
- npm.io page: https://npm.io/package/@vimlet/commons-progress

## Recent versions

- 0.0.7 (latest) — 2019-03-14
- 0.0.6 — 2019-03-13
- 0.0.5 — 2019-03-08

## README

# Progress

Feedback of running progress to the user.

## Installation

npm install @vimlet/commons-progress

It will be also installed as a module within @vimlet/commons

## Usage


>## progress.paintProgress(value, outputHandler)
>
>Prints progress at a given percent.
>
>* value: Progress percent.
>* outputHandler: Default output callback `function(out)`, >redirects stdout when provided.

>## progress.showProgress(value, options, outputHandler)
>
>Prints progress percent by value and total and returns the percent.
>
>* value: Current progress value.
>* options:
>1. paintProgress: Function that actually does the painting. 
>2. total: Total progress value.
>* outputHandler: Default output callback `function(out)`, redirects stdout when provided.

>## progress.progressHandler(total, max, options, mainOutputHandler)
>
>Handle progress painting avoiding duplicated output of the same progress.
>* total: Total percent value.
>* max:Provide a virtual limit that avoids printing over this value.
>* options:
>1. paintProgress: Function that actually does the painting.
>* mainOutputHandler: Default output callback `function(out)`, redirects stdout when provided.

## License
This project is under MIT License. See [LICENSE](https://github.com/vimlet/vimlet-commons/blob/master/LICENSE) for details.

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