# ora-progress-bar

> A progress bar based on ora library

Latest version **1.2.1** (published 2020-04-17) · MIT license · 0 weekly downloads

## Install

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

## 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.2.1 |
| Published | 2020-04-17 |
| First published | 2020-04-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13 |
| Author | ZE0TRON |
| Maintainers | ze0tron |
| Keywords | ora, progressbar, progress, bar, cli, progress-bar |

## Links

- npm: https://www.npmjs.com/package/ora-progress-bar
- Repository: https://github.com/ZE0TRON/OraProgressBar
- Homepage: https://github.com/ZE0TRON/OraProgressBar#readme
- Issues: https://github.com/ZE0TRON/OraProgressBar/issues
- npm.io page: https://npm.io/package/ora-progress-bar

## Dependencies (1)

- [ora](https://npm.io/package/ora.md) ^4.0.3

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.2.1 (latest) — 2020-04-17
- 1.2.0 — 2020-04-16
- 1.1.0 — 2020-04-15
- 1.0.1 — 2020-04-15
- 1.0.0 — 2020-04-15

## README

# Ora Progress Bar

A cli progress bar based on ora library.

![](https://raw.githubusercontent.com/ZE0TRON/OraProgressBar/master/promo.gif)

[NPM link](https://www.npmjs.com/package/ora-progress-bar)

## Usage

### Create a ProgressBar(title,numberOfSteps,options?)

```javascript
const ProgressBar = require("ora-progress-bar");

const progressBar = new ProgressBar("Current Progress", 100);
```

The options parameter is optional if you want to customize the ora spinner you can pass them [see](https://github.com/sindresorhus/ora#readme).

### Increase the progress using progressBar.progress(progress=1)

```javascript
progressBar.progress();

progressBar.progress(5);
```

### Fail or Succeed

By default when the progressBar reaches its goal, it stops and succeeds. But you can force them to fail or succeed manually.

```javascript
try {
  // do stuff
  progressBar.progress();
} catch (e) {
  progressBar.fail();
}
```

```javascript
if (flag) {
  progressBar.succeed();
} else {
  progressBar.progress();
}
```

### Update goal and current progress on the run

```javascript
if (newWorkReceived) progressBar.updateGoal(progressBar.goal + newWork.length);
```

```javascript
if (batchFailed) progressBar.updateProgress(0);
```

#### Note

Only one progress bar can be active at a time.

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