si-funciona 2.0.4 → 2.2.0

package/README.md

@@ -580,9 +580,14 @@ Manage how functions are called with these utilities.
     * [.relevancyFilter(map, [options])](#module_functionHelpers.relevancyFilter) ⇒ <code>relevanceMap</code>
     * [.queueTimeout([queueManagerHandle])](#module_functionHelpers.queueTimeout) ⇒ <code>module:functionHelpers~queueTimeoutHandle</code>
     * [.queueManager([queue])](#module_functionHelpers.queueManager) ⇒ <code>module:functionHelpers~queueManagerHandle</code>
+        * [~makeQueuedRunnable(resolve, reject, fn, ...args)](#module_functionHelpers.queueManager..makeQueuedRunnable) ⇒ <code>queuedRunnable</code>
+        * [~postRun(result)](#module_functionHelpers.queueManager..postRun) ⇒ <code>\*</code>
+        * [~runNextItem()](#module_functionHelpers.queueManager..runNextItem) ⇒ <code>IteratorYieldResult</code> \| <code>null</code>
+        * [~pushAnother(fn, ...args)](#module_functionHelpers.queueManager..pushAnother) ⇒
     * [.preloadParams(fn, params, [unassignedParam])](#module_functionHelpers.preloadParams) ⇒ <code>module:functionHelpers~callWithMissing</code>
     * [.pipe(...fns)](#module_functionHelpers.pipe) ⇒ <code>\*</code>
     * [.onBodyLoad(callback, [reset])](#module_functionHelpers.onBodyLoad) ⇒ <code>Array.&lt;function()&gt;</code>
+    * [.makeBasicQueue(initialQueue)](#module_functionHelpers.makeBasicQueue) ⇒ <code>IsQueue</code>
     * [.delay(time)](#module_functionHelpers.delay) ⇒ <code>module:functionHelpers~delayHandler</code>
     * [.curry(fn)](#module_functionHelpers.curry) ⇒ <code>function</code> \| <code>\*</code>
     * [.callWithParams(fn, params, [minimum])](#module_functionHelpers.callWithParams) ⇒ <code>\*</code>
@@ -633,7 +638,58 @@ Manage functions to run sequentially.
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| [queue] | <code>Iterable</code> \| <code>array</code> | <code>[]</code> | The iterable that can be used to store queued functions |
+| [queue] | <code>IsQueue</code> | <code>[]</code> | The iterable that can be used to store queued functions |
+
+
+* [.queueManager([queue])](#module_functionHelpers.queueManager) ⇒ <code>module:functionHelpers~queueManagerHandle</code>
+    * [~makeQueuedRunnable(resolve, reject, fn, ...args)](#module_functionHelpers.queueManager..makeQueuedRunnable) ⇒ <code>queuedRunnable</code>
+    * [~postRun(result)](#module_functionHelpers.queueManager..postRun) ⇒ <code>\*</code>
+    * [~runNextItem()](#module_functionHelpers.queueManager..runNextItem) ⇒ <code>IteratorYieldResult</code> \| <code>null</code>
+    * [~pushAnother(fn, ...args)](#module_functionHelpers.queueManager..pushAnother) ⇒
+
+<a name="module_functionHelpers.queueManager..makeQueuedRunnable"></a>
+
+#### queueManager~makeQueuedRunnable(resolve, reject, fn, ...args) ⇒ <code>queuedRunnable</code>
+Convert a function to a queueable object.
+
+**Kind**: inner method of [<code>queueManager</code>](#module_functionHelpers.queueManager)  
+
+| Param | Type |
+| --- | --- |
+| resolve | <code>Promise.resolve</code> | 
+| reject | <code>Promise.reject</code> | 
+| fn | <code>function</code> | 
+| ...args | <code>\*</code> | 
+
+<a name="module_functionHelpers.queueManager..postRun"></a>
+
+#### queueManager~postRun(result) ⇒ <code>\*</code>
+After an item is run, THEN run this function to reset isRunning
+
+**Kind**: inner method of [<code>queueManager</code>](#module_functionHelpers.queueManager)  
+
+| Param | Type |
+| --- | --- |
+| result | <code>\*</code> | 
+
+<a name="module_functionHelpers.queueManager..runNextItem"></a>
+
+#### queueManager~runNextItem() ⇒ <code>IteratorYieldResult</code> \| <code>null</code>
+When ready, runs the next queued runnable generator.
+
+**Kind**: inner method of [<code>queueManager</code>](#module_functionHelpers.queueManager)  
+<a name="module_functionHelpers.queueManager..pushAnother"></a>
+
+#### queueManager~pushAnother(fn, ...args) ⇒
+Add a function into the queue to be run when ready.
+
+**Kind**: inner method of [<code>queueManager</code>](#module_functionHelpers.queueManager)  
+**Returns**: Promise  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| fn | <code>function</code> | The function to run when ready |
+| ...args | <code>\*</code> | Optional arguments to apply when the function is ready to be run |
 
 <a name="module_functionHelpers.preloadParams"></a>
 
@@ -673,6 +729,17 @@ Prepare functions to be called once the body is available.
 | callback | <code>function</code> |  | 
 | [reset] | <code>boolean</code> | <code>false</code> | 
 
+<a name="module_functionHelpers.makeBasicQueue"></a>
+
+### functionHelpers.makeBasicQueue(initialQueue) ⇒ <code>IsQueue</code>
+Create an instance of a basic queue.
+
+**Kind**: static method of [<code>functionHelpers</code>](#module_functionHelpers)  
+
+| Param | Type |
+| --- | --- |
+| initialQueue | <code>Array</code> | 
+
 <a name="module_functionHelpers.delay"></a>
 
 ### functionHelpers.delay(time) ⇒ <code>module:functionHelpers~delayHandler</code>
@@ -905,6 +972,12 @@ Some simple utility functions for generating arrays or performing work on arrays
 **Author**: Joshua Heagle <joshuaheagle@gmail.com>  
 
 * [arrayHelpers](#module_arrayHelpers)
+    * [.BasicQueue](#module_arrayHelpers.BasicQueue)
+        * [.dequeue()](#module_arrayHelpers.BasicQueue+dequeue) ⇒ <code>queuedItem</code> \| <code>\*</code>
+        * [.empty()](#module_arrayHelpers.BasicQueue+empty) ⇒ <code>boolean</code>
+        * [.enqueue(data)](#module_arrayHelpers.BasicQueue+enqueue) ⇒ <code>BasicQueue</code>
+        * [.peek()](#module_arrayHelpers.BasicQueue+peek) ⇒ <code>queuedItem</code> \| <code>\*</code>
+        * [.size()](#module_arrayHelpers.BasicQueue+size) ⇒ <code>number</code>
     * [.uniqueArray(array)](#module_arrayHelpers.uniqueArray) ⇒ <code>Array</code>
     * [.mergeArrays(...arrays)](#module_arrayHelpers.mergeArrays) ⇒ <code>Array</code>
     * [.compareArrays(...arrays)](#module_arrayHelpers.compareArrays) ⇒ <code>Array.&lt;module:arrayHelpers~compareArrayResult&gt;</code>
@@ -912,6 +985,55 @@ Some simple utility functions for generating arrays or performing work on arrays
     * [.buildArray(item, length)](#module_arrayHelpers.buildArray) ⇒ <code>Array.&lt;\*&gt;</code>
     * [.addUniqueToArray(item, array)](#module_arrayHelpers.addUniqueToArray) ⇒ <code>Array</code>
 
+<a name="module_arrayHelpers.BasicQueue"></a>
+
+### arrayHelpers.BasicQueue
+Class BasicQueue is a functional example of a queue to be used with queueManager.
+
+**Kind**: static class of [<code>arrayHelpers</code>](#module_arrayHelpers)  
+
+* [.BasicQueue](#module_arrayHelpers.BasicQueue)
+    * [.dequeue()](#module_arrayHelpers.BasicQueue+dequeue) ⇒ <code>queuedItem</code> \| <code>\*</code>
+    * [.empty()](#module_arrayHelpers.BasicQueue+empty) ⇒ <code>boolean</code>
+    * [.enqueue(data)](#module_arrayHelpers.BasicQueue+enqueue) ⇒ <code>BasicQueue</code>
+    * [.peek()](#module_arrayHelpers.BasicQueue+peek) ⇒ <code>queuedItem</code> \| <code>\*</code>
+    * [.size()](#module_arrayHelpers.BasicQueue+size) ⇒ <code>number</code>
+
+<a name="module_arrayHelpers.BasicQueue+dequeue"></a>
+
+#### basicQueue.dequeue() ⇒ <code>queuedItem</code> \| <code>\*</code>
+Remove and return the next item in the queue
+
+**Kind**: instance method of [<code>BasicQueue</code>](#module_arrayHelpers.BasicQueue)  
+<a name="module_arrayHelpers.BasicQueue+empty"></a>
+
+#### basicQueue.empty() ⇒ <code>boolean</code>
+Check if the queue is empty
+
+**Kind**: instance method of [<code>BasicQueue</code>](#module_arrayHelpers.BasicQueue)  
+<a name="module_arrayHelpers.BasicQueue+enqueue"></a>
+
+#### basicQueue.enqueue(data) ⇒ <code>BasicQueue</code>
+Add an item to the end of the queue
+
+**Kind**: instance method of [<code>BasicQueue</code>](#module_arrayHelpers.BasicQueue)  
+
+| Param | Type |
+| --- | --- |
+| data | <code>queuedItem</code> \| <code>\*</code> | 
+
+<a name="module_arrayHelpers.BasicQueue+peek"></a>
+
+#### basicQueue.peek() ⇒ <code>queuedItem</code> \| <code>\*</code>
+Retrieve the next item from the queue
+
+**Kind**: instance method of [<code>BasicQueue</code>](#module_arrayHelpers.BasicQueue)  
+<a name="module_arrayHelpers.BasicQueue+size"></a>
+
+#### basicQueue.size() ⇒ <code>number</code>
+Get the quantity of items in the queue
+
+**Kind**: instance method of [<code>BasicQueue</code>](#module_arrayHelpers.BasicQueue)  
 <a name="module_arrayHelpers.uniqueArray"></a>
 
 ### arrayHelpers.uniqueArray(array) ⇒ <code>Array</code>