package
Memory-efficient module that tracks the current average value of an unlimited series of numbers
npm install running-averageGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Estimated unpacked size across 1 packages.
4.4 kB
Includes dependencies.
Memory-efficient module that tracks the current average value of an unlimited series of numbers.
import { RunningAverage } from 'running-average'; // ES modules
// create an instance
const runningAverage = new RunningAverage();
// push a number
runningAverage.push(1);
// or a few numbers
runningAverage.push(2, 3, 4);
// or an array of numbers
runningAverage.push([5, 6, 7]);
// get the current average any time you want
runningAverage.getAverage(); // => 4
// add some more numbers
runningAverage.push(8, 9);
// get an updated average
runningAverage.getAverage(); // => 5
// oh, and it's chainable too!
runningAverage.push(10).push(11).getAverage(); // => 6
See version 2.x for a non-ESM version (CommonJS (require(...))/UMD).
Also see version 1.x for a windowSize option to limit the average to the last n numbers, but be aware that it uses a less efficient algorithm.
MIT © Nathan Friedly