Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/airtoxin/sandglass
Time windowed stream aggregation
https://github.com/airtoxin/sandglass
Last synced: about 9 hours ago
JSON representation
Time windowed stream aggregation
- Host: GitHub
- URL: https://github.com/airtoxin/sandglass
- Owner: airtoxin
- License: mit
- Created: 2015-02-27T21:27:28.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-04-30T23:58:18.000Z (over 9 years ago)
- Last Synced: 2024-11-01T20:38:26.493Z (5 days ago)
- Language: JavaScript
- Homepage:
- Size: 867 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#sandglass [](http://badge.fury.io/js/sandglass) [](https://travis-ci.org/airtoxin/sandglass)
Aggregates data stream timeline as time window.
#Install
[](https://npmjs.org/package/sandglass)
#Usage
```javascript
var Sandglass = require( 'sandglass' );
var sandglass = new Sandglass();
```
#Sandglass Instance Methods
##emit( data );
Send data to all SandStreams.
##absoluteSlice( timespan );
Slices data stream timeline with timespan and aggregates each slice of data stream. Next aggregation starts after one aggregation ends, and another one starts again and again.
__Arguments__
1. timespan(Number): slice size (millisecond).
__Returns__
(sandStream): Fires `aggregate` event after stream aggregation.
`emitter.on( 'aggregate', callback );`
`callback` gets an array of streaming data.
__Example__
```javascript
var sandStream = sandglass.absoluteSlice( 1000 );
setTimeout( function() { sandglass.emit( 1 ) }, 500 );
setTimeout( function() { sandglass.emit( 2 ) }, 800 );
setTimeout( function() { sandglass.emit( 3 ) }, 1700 );
setTimeout( function() { sandglass.emit( 4 ) }, 2100 );
setTimeout( function() { sandglass.emit( 5 ) }, 2300 );
setTimeout( function() { sandglass.emit( 6 ) }, 5000 );
sandStream.on( 'aggregate', function ( agg ) {
console.log( '@agg:', agg );
// => [ 1, 2, 3 ] (1 second later)
// => [ 4, 5 ] (2 second later)
// => [ 6 ] (3 second later)
// => [] (6 second later)
// ...
} );
```
##relativeSlice( timespan );
Slices data stream timeline with timespan and aggregates each slice of data stream. The aggregation starts at each incoming data, and it ends after it takes the timespan.
(Same as delayedCount)
__Arguments__
1. timespan(Number): slice size (millisecond).
__Returns__
(sandStream): Fires `aggregate` event after stream aggregation.
`emitter.on( 'aggregate', callback );`
`callback` gets an array of streaming data.
__Example__
```javascript
var sandStream = sandglass.absoluteSlice( 1000 );
setTimeout( function() { sandglass.emit( 1 ) }, 500 );
setTimeout( function() { sandglass.emit( 2 ) }, 800 );
setTimeout( function() { sandglass.emit( 3 ) }, 1700 );
setTimeout( function() { sandglass.emit( 4 ) }, 2100 );
setTimeout( function() { sandglass.emit( 5 ) }, 2300 );
setTimeout( function() { sandglass.emit( 6 ) }, 5000 );
sandStream.on( 'aggregate', function ( agg ) {
console.log( '@agg:', agg );
// => [ 1, 2 ] ( 1.5 second later )
// => [ 2, 3 ] ( 1.8 second later )
// => [ 3, 4, 5 ] ( 2.7 second later )
// => [ 4, 5 ] ( 3.1 second later )
// => [ 5 ] ( 3.3 second later )
// => [ 6 ] ( 6 second later )
} );
```
##liveCount( timespan );
When data incomes, 'liveCount' reserve the data.
At the same time 'liveCount' sends data as aggregation which was reserved untill at that time.
Each data is disposed after it takes timespan.
__Arguments__
1. timespan(Number): slice size (millisecond).
__Returns__
(sandStream): Fires `aggregate` event after stream aggregation.
`emitter.on( 'aggregate', callback );`
`callback` gets an array of reserved streaming data.
##delayedCount( timespan );
Aliase of relativeSlice (Same as relativeSlice).
When data incomes, 'delayedCount' reserve the data.
After it takes timespan, 'delayedCount' sends data as aggregation which was reserved untill at that time,
and then the data is disposed.
#SandStream Instance Methods
##on( event, listener );
Set event listener.
`sandStream.on( 'aggregate', function( agg ) {...} )`
##off( event, listener );
Remove event listener.
##stop();
Stop aggregation. GC works.
##other methods
see [EventEmitter2](https://github.com/asyncly/EventEmitter2)