https://github.com/mengstr/troll-avg
Time based rolling average calculations for node.js
https://github.com/mengstr/troll-avg
Last synced: 8 months ago
JSON representation
Time based rolling average calculations for node.js
- Host: GitHub
- URL: https://github.com/mengstr/troll-avg
- Owner: mengstr
- License: mit
- Created: 2014-06-07T05:40:01.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2014-06-12T08:36:36.000Z (about 12 years ago)
- Last Synced: 2025-02-11T09:19:03.598Z (over 1 year ago)
- Language: JavaScript
- Size: 188 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# troll-avg [](https://travis-ci.org/SmallRoomLabs/troll-avg)
Time-based rolling average calculations for node.js
## Installation
Via [npm][]:
$npm install --save troll-avg
## Quick Start
```javascript
var Troll=require('troll-avg');
// Setup 5 counting slots collecting updates for 1 second each
// for three different keys. This will give the average values
// over the last 5 seconds.
var ravg=new Troll(['foo','bar','bletch'], 1, 5);
// Increment a random key by 1 every 250 mS
setInterval(function() {
var r=Math.random();
if (r<0.1) { // 10% goes to boo
ravg.update('foo');
} else if (r<0.4) { // 30% goes to bar
ravg.update('bar');
} else { // 60% goes to bletch
ravg.update('bletch');
}
},250);
// Show all averages every second
setInterval(function() {
console.log(ravg.averages());
}, 1000);
```
## Methods
### Constructor (allowedKeys, period, binCount)
The constructor expects three arguments.
1. An array of the keys that are being averaged.
2. How many seconds the data for each key is collected into one bins.
3. How many bins that the average is calculated over.
### .update(key, cnt)
Add then *cnt* value into the current bin. If *cnt* is not specified it defaults to 1.
### .average(key)
Return the rolling average value for the specified key.
### .averages()
Return the rolling average values for all keys as an object.
## Notes
Since the collection of the values for the current time period is made into a separate set of bins calling .average() or .averages() before the first time period have elapsed the returned average(s) will be zero(s).
## Testing
Unit tests are done with mocha/chai. They can be run with ```npm test```
## License
Released under the MIT License
Copyright (c) 2014 Mats Engstrom - SmallRoomLabs
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
[npm]: https://npmjs.org