# ts-progress-ascii

> ASCII progress bars in the terminal

Latest version **3.1.1** (published 2023-08-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install ts-progress-ascii
pnpm add ts-progress-ascii
yarn add ts-progress-ascii
bun add ts-progress-ascii
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.1 |
| Published | 2023-08-08 |
| First published | 2023-08-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 58.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | DeathlyBower959 |
| Maintainers | deathlybower959yt |
| Keywords | ascii, cli, node, progress, progressbar, typescript, terminal, utility |

## Links

- npm: https://www.npmjs.com/package/ts-progress-ascii
- Repository: https://github.com/DeathlyBower959/ts-progress-ascii
- Homepage: https://github.com/DeathlyBower959/ts-progress-ascii#readme
- Issues: https://github.com/DeathlyBower959/ts-progress-ascii/issues
- npm.io page: https://npm.io/package/ts-progress-ascii

## Dependencies (4)

- [ansi](https://npm.io/package/ansi.md) ^0.3.1
- [@types/ansi](https://npm.io/package/@types/ansi.md) ^0.3.3
- [get-cursor-position](https://npm.io/package/get-cursor-position.md) ^2.0.0
- [@total-typescript/ts-reset](https://npm.io/package/@total-typescript/ts-reset.md) ^0.4.2

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

- 3.1.1 (latest) — 2023-08-08
- 3.1.0 — 2023-08-08
- 3.0.0 — 2023-08-07
- 2.0.0 — 2023-08-07
- 1.0.0 — 2023-08-06

## README

# ts-progress-ascii

## Presets

`import { Styles } from 'ts-progress-ascii` for implemented presets

## Template String

### Variables

Keywords starting with `@` will look for available keywords. If not valid, the character will just be printed out

```ts
// Available keywords
@spinner
@bar
@percentage
@completed
@total
```

### Colors

Hex or color names can be used in the template string

```ts
(#blue)@spinner
(#6f3ddb)@spinner
```

```ts
// Color names
(#red)
(#green)
(#blue)
(#yellow)
(#purple)
(#cyan)
(#gray)
(#white)
(#black)

// Hex Codes
(#6f3ddb)
(#e8b4c3)
(#0b5a95)
```

## Styles

### Loader

The spinners are an array of strings, each item being a frame to the animation. They are cycled through every time `.tick()` is run

```ts
['◢', '◣', '◤', '◥'] Triangle
['◰', '◳', '◲', '◱'] Corner Squares

Many of the default animations are too long to display here
```

### Bar

A tuple of two items is used, the first being the `filled` character, and the second the `empty` character

```ts
["█" , "░"] Rect_DottedRect
["-", " "] Hyphen_Space
["#" , "-"] Hash_Hyphen
["■" , " "] Square_Empty
["■" , "-"] Square_Hyphen
["■" , "□"] Square_EmptySquare
["▰" , "▱"] Slant_EmptySlant
```

## License

The scripts and documentation in this project are released under the [MIT License](LICENSE)

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