From bf5f56ca2cceb73fc125eda60d293f188286f9fa Mon Sep 17 00:00:00 2001
From: "Alex A. Naanou" <alex.nanou@gmail.com>
Date: Fri, 2 Apr 2021 11:25:42 +0300
Subject: [PATCH] docs...

Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
---
 Array.js     |   1 +
 Date.js      |   2 +-
 README.md    | 329 +++++++++++++++++++++++++++++++++++++++++++++++++++
 package.json |   2 +-
 4 files changed, 332 insertions(+), 2 deletions(-)

diff --git a/Array.js b/Array.js
index d69d837..c0ff669 100644
--- a/Array.js
+++ b/Array.js
@@ -92,6 +92,7 @@ var wrapIterFunc = function(iter){
 // 		go through a chunk...
 //		...the mixin can be generic, i.e. applicable to Array, and 
 //		other stuff...
+// XXX add time-based chunk iteration...
 var makeChunkIter = function(iter, wrapper){
 	wrapper = wrapper
 		|| function(res, func, array, e){
diff --git a/Date.js b/Date.js
index 801391e..0186543 100644
--- a/Date.js
+++ b/Date.js
@@ -43,7 +43,7 @@ object.Mixin('DateMixin', 'soft', {
 					+ parseFloat(m || 0))*60 
 						+ parseFloat(s || 0))*1000 + ms)
 
-		// 00set format...
+		// 00sec format...
 		} else {
 			var val = parseFloat(str)
 			str = str.trim()
diff --git a/README.md b/README.md
index f206c6f..891a64c 100644
--- a/README.md
+++ b/README.md
@@ -807,6 +807,9 @@ The `.map(..)`, `.filter(..)` and `.reduce(..)` alternatives respectively:
 <func>(<state>, <item>, <index>, <array>)
   -> <state>
 ```
+<!-- XXX Example -->
+
+
 
 All three support chunk handlers in the same way (illustrated on `.mapChunks(..)`):
 ```bnf
@@ -823,6 +826,8 @@ All three support chunk handlers in the same way (illustrated on `.mapChunks(..)
 The `<chunk-handler>` gets the completed chunk of data after it is computed 
 but before the timeout.
 
+<!-- XXX Example -->
+
 
 
 ## `Map`
@@ -831,8 +836,14 @@ but before the timeout.
 require('ig-types/Map')
 ```
 
+<!-- XXX -->
+
+
 ### `<map>.sort(..)`
 
+<!-- XXX -->
+
+
 
 
 ## `Set`
@@ -841,15 +852,30 @@ require('ig-types/Map')
 require('ig-types/Set')
 ```
 
+<!-- XXX -->
+
+
 
 ### `<set>.unite(..)`
 
+<!-- XXX -->
+
+
 ### `<set>.intersect(..)`
 
+<!-- XXX -->
+
+
 ### `<set>.subtract(..)`
 
+<!-- XXX -->
+
+
 ### `<set>.sort(..)`
 
+<!-- XXX -->
+
+
 
 ## `Date`
 
@@ -857,18 +883,102 @@ require('ig-types/Set')
 require('ig-types/Date')
 ```
 
+<!-- XXX -->
+
+
 ### `Date.timeStamp(..)`
 
+<!-- XXX -->
+
+
 ### `Date.fromTimeStamp(..)`
 
+<!-- XXX -->
+
+
 ### `Date.str2ms(..)`
 
+Convert a string describing a time period into milliseconds.
+```bnf
+Date.str2ms(<str>)
+    -> <number>
+```
+
+Examples:
+```javascript
+// time units (d/h/m/s/ms) and their variants...
+var a = Date.str2ms('3 seconds') // -> 3000
+
+var b = Date.str2ms('0.1h') // -> 360000
+
+// time period (DD:HH:MM:SS:mmm)...
+var c = Date.str2ms('00:20:001') // -> 20001
+var d = Date.str2ms('1:3') // -> 63000
+```
+
+Note that time periods are seconds-based by default unless it contains three 
+digits then it defaults to milliseconds:
+```javascript
+// least significant unit is seconds by default...
+var e = Date.str2ms(':3') // -> 3000
+
+// when the least significant unit contains 3 digits it is read as ms...
+var f = Date.str2ms(':030') // -> 30
+```
+
+
+Supported formats:
+```bnf
+<str> ::=
+    <milliseconds>
+    | <seconds>
+    | <minutes>
+    | <hours>
+    | <days>
+    | <period>
+
+<milliseconds> ::=
+    <number>
+    | <number>ms
+    | <number>m[illi][-]s[ec[ond[s]]]
+
+<seconds> ::=
+    <number>s
+    | <number>s[ec[ond[s]]]
+
+<seconds> ::=
+    <number>m
+    | <number>m[in[ute[s]]]
+
+<seconds> ::=
+    <number>h
+    | <number>h[our[s]]
+    
+<seconds> ::=
+    <number>d
+    | <number>d[ay[s]]
+
+<period> ::= 
+    [[[DD:]HH:]MM]:SS[:mmm]
+    | [[[[DD:]HH:]MM]:SS]:mmm
+```
+
+
 ### `<date>.toShortDate(..)`
 
+<!-- XXX -->
+
+
 ### `<date>.getTimeStamp(..)`
 
+<!-- XXX -->
+
+
 ### `<date>.setTimeStamp(..)`
 
+<!-- XXX -->
+
+
 
 ## `String`
 
@@ -878,8 +988,14 @@ require('ig-types/String')
 
 ### `<string>.capitalize()`
 
+<!-- XXX -->
+
+
 ### `<string>.indent(..)`
 
+<!-- XXX -->
+
+
 
 ## `RegExp`
 
@@ -887,8 +1003,14 @@ require('ig-types/String')
 require('ig-types/RegExp')
 ```
 
+<!-- XXX -->
+
+
 ### `RegExp.quoteRegExp(..)`
 
+<!-- XXX -->
+
+
 
 ## `Promise`
 
@@ -900,16 +1022,31 @@ or
 var promise = require('ig-types/Promise')
 ```
 
+<!-- XXX -->
+
+
 
 
 ### Cooperative promises
 
+<!-- XXX -->
+
+
 #### `Promise.cooperative(..)`
 
+<!-- XXX -->
+
+
 #### `<promise-coop>.set(..)`
 
+<!-- XXX -->
+
+
 #### `<promise-coop>.isSet`
 
+<!-- XXX -->
+
+
 
 ### Promise iteration
 
@@ -974,13 +1111,25 @@ Create an _iterable promise_
 Promise.iter(<array>)
     -> <iterable-promise>
 ```
+
+<!-- XXX -->
+
 #### `<promise-iter>.map(..)` / `<promise-iter>.filter(..)` / `<promise-iter>.reduce(..)`
 
+<!-- XXX -->
+
+
 #### `<promise-iter>.flat(..)`
 
+<!-- XXX -->
+
+
 
 #### `<promise-iter>.then(..)` / `<promise-iter>.catch(..)` / `<promise-iter>.finally(..)`
 
+<!-- XXX -->
+
+
 #### Advanced handler
 
 ```bnf
@@ -1027,6 +1176,9 @@ var p = Promise.iter(
 var generator = require('ig-types/generator')
 ```
 
+<!-- XXX -->
+
+
 
 ### The basics
 
@@ -1132,6 +1284,9 @@ XXX .reduce(..) can return a non-iterable -- test and document this case...
     -> <generator>
 ```
 
+<!-- XXX -->
+
+
 <!-- XXX check this 
 This does not support negative indexes.
 -->
@@ -1264,18 +1419,33 @@ XXX only list the differences + reference to the above...
 
 #### `<Generator>.at(..)`
 
+<!-- XXX -->
+
+
 #### `<Generator>.shift()` / `<Generator>.pop()`
 
+<!-- XXX -->
+
+
 #### `<Generator>.slice(..)`
 
 This is like `Array`'s `.slice(..)` but does not support negative indexes.
 
 #### `<Generator>.map(..)` / `<Generator>.filter(..)` / `<Generator>.reduce(..)` / `<Generator>.flat()`
 
+<!-- XXX -->
+
+
 #### `<Generator>.toArray()`
 
+<!-- XXX -->
+
+
 #### `<Generator>.then(..)` / `<Generator>.catch(..)` / `<Generator>.finally(..)`
 
+<!-- XXX -->
+
+
 
 ## Containers
 
@@ -1404,18 +1574,39 @@ otherwise [`.unorderedRename(..)`](#unique-key-mapunorderedrename) is called.
 
 #### `<unique-key-map>.orderedRename(..)`
 
+<!-- XXX -->
+
+
 #### `<unique-key-map>.unorderedRename(..)`
 
+<!-- XXX -->
+
+
 #### `<unique-key-map>.keysOf(..)`
 
+<!-- XXX -->
+
+
 #### `<unique-key-map>.originalKey(..)`
 
+<!-- XXX -->
+
+
 #### `<unique-key-map>.uniqueKey(..)`
 
+<!-- XXX -->
+
+
 #### `<unique-key-map>.__key_pattern__`
 
+<!-- XXX -->
+
+
 #### `<unique-key-map>.__unordered_rename__`
 
+<!-- XXX -->
+
+
 
 ## Event
 
@@ -1426,29 +1617,62 @@ var event = require('ig-types/event')
 
 ### `event.Eventfull(..)`
 
+<!-- XXX -->
+
+
 ### `event.Event(..)`
 
+<!-- XXX -->
+
+
 ### `event.TRIGGER`
 
+<!-- XXX -->
+
+
 Special value when passed to an event method as first argument will force it 
 to trigger event if the first argument was a function.
 
 ### `event.EventHandlerMixin`
 
+<!-- XXX -->
+
+
 #### `<obj>.on(..)`
 
+<!-- XXX -->
+
+
 #### `<obj>.one(..)`
 
+<!-- XXX -->
+
+
 #### `<obj>.off(..)`
 
+<!-- XXX -->
+
+
 #### `<obj>.trigger(..)`
 
+<!-- XXX -->
+
+
 ### `event.EventDocMixin`
 
+<!-- XXX -->
+
+
 #### `<obj>.eventfull`
 
+<!-- XXX -->
+
+
 #### `<obj>.events`
 
+<!-- XXX -->
+
+
 ### `event.EventMixin`
 
 Combines [`event.EventHandlerMixin`](#eventeventhandlermixin) and 
@@ -1462,16 +1686,28 @@ var runner = require('ig-types/runner')
 
 ### Micro task queue
 
+<!-- XXX -->
+
+
 
 This includes [`event.EventMixin`](#eventeventmixin).
 
 #### `STOP`
 
+<!-- XXX -->
+
+
 #### `SKIP`
 
+<!-- XXX -->
+
+
 
 #### `Queue(..)` / `Queue.runTasks(..)`
 
+<!-- XXX -->
+
+
 #### `Queue.handle(..)`
 
 Create a handler queue object.
@@ -1498,38 +1734,77 @@ var handler_queue = Queue({
 
 #### `<queue>.state`
 
+<!-- XXX -->
+
+
 
 #### `<queue>.start(..)`
 
+<!-- XXX -->
+
+
 #### `<queue>.stop(..)`
 
+<!-- XXX -->
+
+
 
 #### `<queue>.runTask(..)`
 
+<!-- XXX -->
+
+
 
 #### `<queue>.tasksAdded(..)` (event)
 
+<!-- XXX -->
+
+
 #### `<queue>.taskStarting(..)` (event)
 
+<!-- XXX -->
+
+
 #### `<queue>.taskFailed(..)` (event)
 
+<!-- XXX -->
+
+
 #### `<queue>.taskCompleted(..)` (event)
 
 Event, triggered when a task is completed passing in its result.
 
+<!-- XXX -->
+
+
 
 #### `<queue>.queueEmpty(..)` (event)
 
+<!-- XXX -->
+
+
 
 #### `<queue>.prioritize(..)`
 
+<!-- XXX -->
+
+
 #### `<queue>.delay(..)`
 
+<!-- XXX -->
+
+
 
 #### `<queue>.add(..)`
 
+<!-- XXX -->
+
+
 #### `<queue>.clear(..)`
 
+<!-- XXX -->
+
+
 
 
 #### `FinalizableQueue(..)` / `FinalizableQueue.runTasks(..)` (Queue)
@@ -1547,53 +1822,107 @@ When a `<finalizable-queue>` reaches a terminal state it is frozen.
 
 #### `<finalizable-queue>.done(..)` (event/method)
 
+<!-- XXX -->
+
+
 #### `<finalizable-queue>.abort(..)` (event/method)
 
+<!-- XXX -->
+
+
 
 #### `<finalizable-queue>.promise(..)`
 
+<!-- XXX -->
+
+
 #### `<finalizable-queue>.then(..)`
 
+<!-- XXX -->
+
+
 #### `<finalizable-queue>.catch(..)`
 
+<!-- XXX -->
+
+
 
 
 
 ### Large task management
 
+<!-- XXX -->
+
+
 #### `runner.TaskManager(..)`
 
+<!-- XXX -->
+
+
 
 This includes [`event.EventMixin`](#eventeventmixin).
 
 #### `<task-manager>.Task(..)`
 
+<!-- XXX -->
+
+
 #### `<task-manager>.sync_start`
 
+<!-- XXX -->
+
+
 #### `<task-manager>.record_times`
 
+<!-- XXX -->
+
+
 
 
 #### `<task-manager>.titled(..)`
 
+<!-- XXX -->
+
+
 #### `<task-manager>.send(..)`
 
+<!-- XXX -->
+
+
 #### `<task-manager>.stop(..)`
 
+<!-- XXX -->
+
+
 
 
 #### `<task-manager>.done(..)` (event)
 
+<!-- XXX -->
+
+
 #### `<task-manager>.error(..)` (event)
 
+<!-- XXX -->
+
+
 #### `<task-manager>.tasksDone(..)` (event)
 
+<!-- XXX -->
+
+
 
 
 #### `runner.TaskTicket(..)`
 
+<!-- XXX -->
+
+
 #### `runner.TaskMixin(..)`
 
+<!-- XXX -->
+
+
 
 
 ## License
diff --git a/package.json b/package.json
index eda777f..6ce3b9e 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ig-types",
-  "version": "6.0.9",
+  "version": "6.0.10",
   "description": "Generic JavaScript types and type extensions...",
   "main": "main.js",
   "scripts": {