fluent-time

a fluent api making it easier work with intervals and timeouts

npm install fluent-time
7 downloads in the last week
28 downloads in the last month

fluent-time.js Build Status

fluent time works as a wrapper around setTimeout and setInterval and aims to provide a simpler api for them.

installation

node.js

npm install fluent-time

bower

bower install fluent-time

regular include

download fluent-time.js or fluent-time.min.js and include it.

accessing the api.

we don't want to pollute your global/module scope without asking, but it gives the best looking fluent code. So you can do it yourself, like this;

node.js

var every = require('fluent-time').every;

clientside

var every = FluentTime.every;

intervals

every(5).seconds(function() {
  // code...
});

every(4).hours().and(2).minutes(function() {
  // code...
});
every(5).seconds(function(interval) {
  interval.times; // will be a number of how many times the interval has occured.
});
every(5).minutes(function(interval) {
  if(someCondition) {
    interval.skip(2); // skip the next two executions.
  }

  if (interval.times === 100) {
    interval.cancel(); // cancel the interval.
  }
});

timeouts

// runs the provided function after 10 seconds
after(10).seconds(function() {

});

Tests

the tests are written in mocha and are tested in both node and browser using phantomjs (although travis only runs the node version).

License

(The MIT License)

Copyright (c) 2012 Markus Ullmark

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 loves you