# progress-smoother

> Smoothing function for progress bars (e.g. upload, download, etc.)

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

## Install

```sh
npm install progress-smoother
pnpm add progress-smoother
yarn add progress-smoother
bun add progress-smoother
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.7.0 |
| Published | 2023-08-16 |
| First published | 2022-03-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 14 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Bytescale |
| Maintainers | upload-js, upload-io |
| Keywords | smoothing, smoother, smoothing function, progress, progress bar, progress bars, smooth progress, smooth progress bar |

## Links

- npm: https://www.npmjs.com/package/progress-smoother
- Repository: https://github.com/bytescale/progress-smoother
- Issues: https://github.com/bytescale/progress-smoother/issues
- npm.io page: https://npm.io/package/progress-smoother

## Recent versions

- 1.7.0 (latest) — 2023-08-16
- 1.6.0 — 2023-08-16
- 1.5.0 — 2023-08-16
- 1.4.0 — 2023-01-18
- 1.3.0 — 2022-03-01
- 1.2.1 — 2022-03-01
- 1.2.0 — 2022-03-01
- 1.1.0 — 2022-03-01
- 1.0.2 — 2022-03-01
- 1.0.1 — 2022-03-01
- 1.0.0 — 2022-03-01

## README

<h1 align="center">
    <code>progress-smoother</code>
</h1>

<p align="center"><b>Smoothing Function for Progress Bars</b></p>
<br/>
<p align="center">
  <a href="https://github.com/bytescale/progress-smoother/">
    <img src="https://img.shields.io/badge/gzipped-743%20Bytes-4ba0f6" />
  </a>

  <a href="https://www.npmjs.com/package/progress-smoother">
    <img src="https://img.shields.io/badge/progress--smoother-npm-4ba0f6" />
  </a>

  <a href="https://github.com/bytescale/progress-smoother/actions/workflows/ci.yml">
    <img src="https://img.shields.io/badge/build-passing-4ba0f6" />
  </a>

  <a href="https://www.npmjs.com/package/progress-smoother">
    <img src="https://img.shields.io/npm/dt/progress-smoother?color=%234ba0f6" />
  </a>
  <br/>

  <a href="https://www.npmjs.com/package/progress-smoother">
    <img src="https://img.shields.io/badge/TypeScript-included-4ba0f6" />
  </a>

  <a href="https://github.com/bytescale/progress-smoother/actions/workflows/ci.yml">
    <img src="https://img.shields.io/npms-io/maintenance-score/progress-smoother?color=4ba0f6" />
  </a>

  <a target="_blank" href="https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fupload-js%2Fprogress-smoother&via=UploadJS&text=I%20just%20found%20%22progress-smoother%22%20on%20NPM%20%E2%80%94%20a%20nice%20smoothing%20function%20to%20use%20in%20progress%20bars.&hashtags=javascript%2Copensource%2Cjs%2Cwebdev%2Cdevelopers">
    <img alt="Twitter URL" src="https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fupload-js%2Fprogress-smoother%2F" />
  </a>
<br/>
</p>

## Installation

```shell
npm install progress-smoother
```

## Usage

```javascript
const { ProgressSmoother } = require("progress-smoother")

const progress = ProgressSmoother({
  // Required.
  maxValue: 12345,                  // Maximum value of your progress bar.
  valueIncreaseRatePerSecond: 5000, // Estimated minimum throughput for '.setValue()' calls.
  valueIncreaseDelta: 500,          // Estimated minimum delta between '.setValue()' calls.
  averageTimeBetweenValues: 5000,   // Estimated mean time between '.setValue()' calls in milliseconds.
  minDelayUntilFirstValue: 6000,    // Estimated minimum delay until the first '.setValue()' call is made.

  // Optional.
  teardownTime: 2000                // Latency your app introduces after 100% progress (the function incorporates it).
});

// Report progress events:
progress.setValue(1025);
progress.setValue(3201);
...
progress.setValue(12345);

// Get smoothed progress any time (e.g. on a fixed interval):
progress.smoothedFactor(); // Returns 0..1
```


## Contribute

If you would like to contribute to `progress-smoother`:

1. Add a [GitHub Star](https://github.com/bytescale/progress-smoother/stargazers) to the project (if you're feeling generous!).
2. Determine whether you're raising a bug, feature request or question.
3. Raise your issue or PR. 🚀

## License

[MIT](LICENSE)

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