readme.md

duration-estimator

Agnostic duration estimator for asynchronous tasks. Estimates remaining time using a moving average whose length is configurable.

Install

Using npm:

npm install duration-estimator --save

Using umd bundle from cdn:

<script src="https://unpkg.com/duration-estimator"></script>
<!-- Globally available as DurationEstimator !-->

Using esm bundle from cdn:

<script type="module">
  import { DurationEstimator } from 'https://cdn.skypack.dev/duration-estimator'
</script>

Usage

import { DurationEstimator } from 'duration-estimator'

// Asynchronous task yielding progress in range 0-1
function task(onProgress) {
  let n = 0
  const steps = 10

  onProgress(0)

  const interval = setInterval(() => {
    onProgress(++n / steps)
    n === steps && clearInterval(interval)
  }, 500)
}

const estimator = new DurationEstimator()

task(progress => console.log(`${estimator.estimate(progress)}ms remaining`))

// Infinityms remaining
// 4536ms remaining
// 4027.9960278053622ms remaining
// 3520.9907223204477ms remaining
// 3014.985074579578ms remaining
// 2512.9896480589387ms remaining
// 2010.6595867972594ms remaining
// 1507.709410925819ms remaining
// 1005.2470758800504ms remaining
// 502.44262539511163ms remaining
// 0ms remaining

The estimator can be reused after calling reset():

estimator.reset() // ready to make estimations for a new task

By default, the estimator computes remaining time based on the last 10 samples it got. You can change that by setting the moving average length:

new DurationEstimator(20) // Takes the last 20 samples in account
new DurationEstimator(Infinity) // Takes all samples in account