createRollingAverage

createRollingAverage(maxSize): ImmutableRollingAverage

Defined in: math/fp/rolling-average.ts:33

Creates a new instance of ImmutableRollingAverage with the specified maximum size for the window.

Parameters

maxSize

number

The maximum number of values to keep in the rolling average window. Must be greater than 0.

Returns

ImmutableRollingAverage

Throws

Will throw an error if maxSize is less than or equal to 0.

Example

let rollingAverage = createRollingAverage(3);
rollingAverage = addValue(rollingAverage, 1);
rollingAverage = addValue(rollingAverage, 2);
rollingAverage = addValue(rollingAverage, 3);
console.log(getAverage(rollingAverage)); // { type: "Left", left: 2 }