# yaprog

> Yet Another Progress Bar

Latest version **0.4.2** (published 2021-01-28) · MIT license · 0 weekly downloads

## Install

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

## 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.4.2 |
| Published | 2021-01-28 |
| First published | 2020-06-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 39 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Gordon Leigh |
| Maintainers | gordonmleigh |
| Keywords | cli, progress, bar |

## Links

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

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

- 0.4.2 (latest) — 2021-01-28
- 0.4.1 — 2021-01-28
- 0.4.0 — 2021-01-28
- 0.3.1 — 2020-07-03
- 0.3.0 — 2020-06-30
- 0.2.2 — 2020-06-30
- 0.2.1 — 2020-06-28
- 0.2.0 — 2020-06-28
- 0.1.0 — 2020-06-27

## README

# yaprog: Yet Another Progress Bar

## What

A command line progress bar for NodeJS.

## How

### Quick Start

```typescript
import { makeProgressBar } from 'yaprog';

const bar = makeProgressBar(`uploading [:bar] :current/:total :custom`, 100);

// set
bar.update(10, { custom: 'replacement text' });

// interrupt the bar and log some text
bar.interrupt(`Some log message here!`);
```

### ProgressBarOptions interface

```typescript
interface ProgressBarOptions {
  completeChar?: string; // defaults to '█'
  incompleteChar?: string; // defaults to '░'
  renderThrottle?: number; // defaults to 16ms (60fps)
  start?: number; // defaults to Date.now()
  stream?: NodeJS.WriteStream; // defaults to process.stderr
  total?: number; // defaults to 0
  width?: number; // defaults to 40
}
```

### ProgressBar interface

```typescript
interface ProgressBar {
  progress: number;
  total: number;
  tokens: ProgressBarTokens;
  clear(): void;
  log(message: string, tokens?: ProgressBarTokens): void;
  render(force?: boolean, tokens?: ProgressBarTokens): void;
  update(current: number, total?: number, tokens?: ProgressBarTokens): void;
  update(current: number, tokens: ProgressBarTokens): void;
}
```

### ProgressBarTokens interface

```typescript
interface ProgressBarTokens {
  [key: string]: any;
}
```

## Why

This is based on [progress](https://www.npmjs.com/package/progress), but simplifies the interface and fixes some bugs.

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