Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gamtiq/chronoman
Utility class to simplify use of timers created by setTimeout
https://github.com/gamtiq/chronoman
action chrono control execute interval manage management period periodic recurrent repeat repeater repeating run setinterval settimeout time timeout timer utility
Last synced: 3 months ago
JSON representation
Utility class to simplify use of timers created by setTimeout
- Host: GitHub
- URL: https://github.com/gamtiq/chronoman
- Owner: gamtiq
- License: mit
- Created: 2013-08-11T17:32:28.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2020-05-06T20:05:46.000Z (over 4 years ago)
- Last Synced: 2024-11-01T15:06:33.027Z (3 months ago)
- Topics: action, chrono, control, execute, interval, manage, management, period, periodic, recurrent, repeat, repeater, repeating, run, setinterval, settimeout, time, timeout, timer, utility
- Language: JavaScript
- Homepage: https://gamtiq.github.io/chronoman/
- Size: 2.09 MB
- Stars: 15
- Watchers: 5
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE
Awesome Lists containing this project
README
# chronoman
[](http://badge.fury.io/js/chronoman)
[](http://travis-ci.org/gamtiq/chronoman)
[](http://gruntjs.com/)
Utility class to simplify use of timers created by `setTimeout`.
### Features
* Support for one-time (like `setTimeout`) or recurrent (like `setInterval`) timers.
* It is possible to repeat action indefinitely (`recurrent` property),
specified number of times (`repeatQty` property) or depending on
result of control function (`repeatTest` property).
* Time period (timeout) can be: a fixed value, a random value, an item selected from a list
depending on action's execution number, or a value returned from specified function.
* Action that is called can be a function or an object specifying function and its call's context.
* Action result is saved in timer's field for further access.
* Timer's start time, stop time and action execution times are saved in
`startTime`, `stopTime` and `executeTime` properties correspondingly.
```js
var timer = new Timer({
period: [100, 200, 300, 400, 500, {start: 100, end: 500}],
repeatQty: 100,
passToAction: true,
action: function(tmr) {
console.log("#", tmr.getExecutionQty() + 1, ":", new Date());
},
active: true
});
...
timer.stop();
```
## Installation
### Node
npm install chronoman
### [Bower](https://bower.io)
bower install chronoman
### AMD, <script>
Use `dist/chronoman.js` or `dist/chronoman.min.js` (minified version).
## Usage
### ECMAScript 6/2015
```js
import Timer from "chronoman";
```
### Node
```js
var Timer = require("chronoman").Timer;
```
### AMD
```js
define(["path/to/dist/chronoman.js"], function(chronoman) {
var Timer = chronoman.Timer;
...
});
```
### Bower, <script>
```html
// сhronoman is available via Chronoman field of window object
var Timer = Chronoman.Timer;
...
```
### Example
```js
var tmrOne = new Timer({
period: function(timer) {
return 1000 + (timer.getExecutionQty() * 100);
},
action: function(timer) {
console.log("---> Timer one. ", timer);
if (! tmrThree.isActive()) {
tmrThree.start();
}
}
});
var tmrTwo = new Timer();
tmrTwo.setPeriod([2000, {start: 1000, end: 1500}])
.setRepeatQty(9)
.setPassToAction(true)
.setAction({
i: 0,
execute: function(timer) {
var nI = ++this.i;
console.log("Timer two. #", nI, timer);
tmrOne.setActive(nI % 2 === 1);
}
});
var tmrThree = new Timer()
.setPeriod(3000)
.setRepeatTest(function() {
return tmrTwo.isActive();
});
tmrThree.onExecute = function() {
console.log("* Timer three. #", this.getExecutionQty() + 1);
};
tmrTwo.start();
```
See `test/chronoman.js` for additional examples.
## API
See [`docs`](https://gamtiq.github.io/chronoman/).
## Related projects
* [NumGen](https://github.com/gamtiq/numgen)
* [povtor](https://github.com/gamtiq/povtor)
## Inspiration
This module is inspired by [qooxdoo](http://qooxdoo.org)'s `qx.event.Timer` class.
## Licence
Copyright (c) 2013-2020 Denis Sikuler
Licensed under the MIT license.