TimeDown

A multi countdown timer for node with namespaces.

Installation

npm install timedown

Usage

var TimeDown = require('timedown');
var timer = TimeDown();

// foo and bar are coundown objects.
var foo = timer.ns('foo', '10s');
var bar = timer.ns('bar', '10s');

// foo counter methods
foo.start();
foo.stop();
foo.reset();
bar.delete();

// bar counter methods
bar.start(20); // refresh rate of 20ms
bar.stop();
bar.restart('200ms', { refresh: '20ms'}); // restart timer with duration of 200ms
bar.reset();
bar.delete();

// Listen to bar counter events
bar.on('tick', function(time) {
  console.log(time.ms);
});

bar.on('start', function(time) {
  console.log('STARTED', time.ms);
});

bar.on('ending', function(time) {
  console.log('ENDING', time.ms);
});

bar.on('stop', function(time) {
  console.log('STOPPED', time.ms);
});

bar.on('reset', function(time) {
  console.log('RESET', time.ms);
});

bar.on('end', function() {
  console.log('ENDED');
});

bar.on('delete', function() {
  console.log('DELETED');
});

// Handle counters from timer main object
timer.start('foo');
timer.start('foo', 20); // 20ms refresh rate
timer.stop('foo');
timer.restart('foo', '200ms'); // restart timer with duration of 200ms
timer.reset('foo'); // reset to initiated values
timer.delete('foo');

// Handle counter events from timer main object
timer.on('tick', function(counter, time) {
  console.log(counter.ns, time.ms);
});

timer.on('start', function(counter, time) {
  console.log('STARTED %s with time %d', counter.ns, time.ms);
});

timer.on('ending', function(counter, time) {
  console.log('ENDING %s with time %d', counter.ns, time.ms);
});

timer.on('reset', function(counter, time) {
  console.log('RESET %s with time %d', counter.ns, time.ms);
});

timer.on('end', function(counter) {
  console.log('ENDED %s', counter.ns);
});

timer.on('delete', function(counter) {
  console.log('DELETED %s', counter.ns);
});

Run tests

$ make test

License

(The MIT License)

Copyright (c) 2013 Jonathan Brumley <[email protected]>

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.