Release version 1.3.0

Author: gamtiq

History.md

@@ -1,3 +1,11 @@
+### 1.3.0 / 2020-01-01
+
+* support object values for `period` property to have ability to get random time periods
+* add fields `actionResult` and `onExecuteResult` to save results of calling `action` and `onExecute`
+* add properties `startTime`, `executeTime` and `stopTime` to save start, execution and stop time
+* `repeatTest` function can return any value that is supported for `period` property to control next execution scheduling
+* export `getRandomValue` function
+
 ### 1.2.0 / 2019-12-26
 
 * support of array and function values for `period` property

README.md

@@ -2,6 +2,19 @@
 
 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 having `execute` method.
+* 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}],

bower.json

@@ -1,7 +1,7 @@
 {
   "name": "chronoman",
   "main": ["dist/chronoman.js", "dist/chronoman.min.js"],
-  "version": "1.2.0",
+  "version": "1.3.0",
   "homepage": "https://github.com/gamtiq/chronoman",
   "authors": [
     "Denis Sikuler"
@@ -15,8 +15,12 @@
     "timeout",
     "interval",
     "repeat",
+    "repeating",
+    "recurrent",
     "period",
     "periodic",
+    "control",
+    "manage",
     "management",
     "utility",
     "chrono",

component.json

@@ -2,7 +2,7 @@
     "name": "chronoman",
     "repository": "gamtiq/chronoman",
     "description": "Utility class to simplify use of timers created by setTimeout",
-    "version": "1.2.0",
+    "version": "1.3.0",
     "keywords": [
 	    "setTimeout",
 	    "setInterval",
@@ -11,9 +11,13 @@
 	    "timeout",
 	    "interval",
         "repeat",
-	    "period",
+        "repeating",
+        "recurrent",
+        "period",
 	    "periodic",
-	    "management",
+        "control",
+        "manage",
+        "management",
 	    "utility",
 	    "chrono",
         "run",

doc/chronoman.js.html

@@ -1098,7 +1098,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a>
 
-		on 2020-01-01T21:31:19+03:00
+		on 2020-01-01T23:50:19+03:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

doc/classes.list.html

@@ -206,7 +206,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a>
 
-		on 2020-01-01T21:31:19+03:00
+		on 2020-01-01T23:50:20+03:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

doc/index.html

@@ -94,6 +94,18 @@
 
     <section class="readme-section">
         <article><h1>chronoman</h1><p>Utility class to simplify use of timers created by <code>setTimeout</code>.</p>
+<h3>Features</h3><ul>
+<li>Support for one-time (like <code>setTimeout</code>) or recurrent (like <code>setInterval</code>) timers.</li>
+<li>It is possible to repeat action indefinitely (<code>recurrent</code> property),
+specified number of times (<code>repeatQty</code> property) or depending on
+result of control function (<code>repeatTest</code> property).</li>
+<li>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.</li>
+<li>Action that is called can be a function or an object having <code>execute</code> method.</li>
+<li>Action result is saved in timer's field for further access.</li>
+<li>Timer's start time, stop time and action execution times are saved in
+<code>startTime</code>, <code>stopTime</code> and <code>executeTime</code> properties correspondingly.</li>
+</ul>
 <pre class="prettyprint source lang-js"><code>var timer = new Timer({
     period: [100, 200, 300, 400, 500, {start: 100, end: 500}],
     repeatQty: 100,
@@ -208,7 +220,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a>
 
-		on 2020-01-01T21:31:19+03:00
+		on 2020-01-01T23:50:20+03:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

doc/module-chronoman-Timer.html

@@ -6218,7 +6218,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a>
 
-		on 2020-01-01T21:31:19+03:00
+		on 2020-01-01T23:50:20+03:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

doc/module-chronoman.html

@@ -1260,7 +1260,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a>
 
-		on 2020-01-01T21:31:19+03:00
+		on 2020-01-01T23:50:20+03:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

doc/modules.list.html

@@ -206,7 +206,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a>
 
-		on 2020-01-01T21:31:19+03:00
+		on 2020-01-01T23:50:19+03:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>