Merge pull request #67 from superbrobenji/develop

Rewrote package and abort system

Author: superbrobenji

docs/jsdoc/AsyncQueue.html

@@ -31,7 +31,7 @@
     <input type="text" id="nav-search" placeholder="Search" />
 
 
-    <h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/superbrobenji/async-queue" target="_blank" class="menu-item" id="repository" >Github repo</a></h2><h3>Classes</h3><ul><li><a href="AsyncQueue.module.exports.html">AsyncQueue.module.exports</a></li></ul><h3>Namespaces</h3><ul><li><a href="AsyncQueue.html">AsyncQueue</a><ul class='methods'><li data-type='method' style='display: none;'><a href="AsyncQueue.html#.add">add</a></li><li data-type='method' style='display: none;'><a href="AsyncQueue.html#.setMaxConcurrency">setMaxConcurrency</a></li><li data-type='method' style='display: none;'><a href="AsyncQueue.html#.setPromiseTimeout">setPromiseTimeout</a></li><li data-type='method' style='display: none;'><a href="AsyncQueue.html#.setRetries">setRetries</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#promiseFunction">promiseFunction</a></li><li><a href="global.html#returnCallback">returnCallback</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/superbrobenji/async-queue" target="_blank" class="menu-item" id="repository" >Github repo</a></h2><h3>Classes</h3><ul><li><a href="AsyncQueue.module.exports.html">AsyncQueue.module.exports</a></li></ul><h3>Namespaces</h3><ul><li><a href="AsyncQueue.html">AsyncQueue</a><ul class='methods'><li data-type='method' style='display: none;'><a href="AsyncQueue.html#.add">add</a></li><li data-type='method' style='display: none;'><a href="AsyncQueue.html#.setMaxConcurrency">setMaxConcurrency</a></li><li data-type='method' style='display: none;'><a href="AsyncQueue.html#.setMaxRetries">setMaxRetries</a></li><li data-type='method' style='display: none;'><a href="AsyncQueue.html#.setPromiseTimeout">setPromiseTimeout</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#abortHandler">abortHandler</a></li><li><a href="global.html#errCallback">errCallback</a></li><li><a href="global.html#promiseFunction">promiseFunction</a></li><li><a href="global.html#resCallback">resCallback</a></li></ul>
 
 </nav>
 
@@ -80,7 +80,7 @@ <h4 class="name" id="AsyncQueue">AsyncQueue</h4>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line2">line 2</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line4">line 4</a>
     </li></ul></dd>
 
 
@@ -177,7 +177,7 @@ <h3 class="subsection-title">Methods</h3>
 
 
 
-    <h4 class="name" id=".add"><span class="type-signature type-signature-static">(static) </span>add<span class="signature">(fn, callback)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id=".add"><span class="type-signature type-signature-static">(static) </span>add<span class="signature">(fn, callback, callback)</span><span class="type-signature"></span></h4>
 
 
 
@@ -194,7 +194,7 @@ <h4 class="name" id=".add"><span class="type-signature type-signature-static">(s
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line174">line 174</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line230">line 230</a>
     </li></ul></dd>
 
 
@@ -251,15 +251,16 @@ <h5 class="h5-examples">Example</h5>
 }
 
 //the callback that is ran on the settlement of the promise
-const callback = (res, err) => {
-  if(err){
-    throw new error(err)
-  }
+const callback = (res) => {
   //do something with response
 }
 
+const error = (err) => {
+  throw new Error(err)
+}
+
 //Adding the promise to the queue
-queue.add(pets, callback)</code></pre>
+queue.add(pets, callback, error)</code></pre>
 
 
 
@@ -319,7 +320,31 @@ <h5 class="h5-parameters">Parameters:</h5>
             <td class="type">
 
 
-<span class="param-type"><a href="global.html#returnCallback">returnCallback</a></span>
+<span class="param-type"><a href="global.html#resCallback">resCallback</a></span>
+
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>The function that is executed when the promise resolves</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>callback</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type"><a href="global.html#errCallback">errCallback</a></span>
 
 
 
@@ -330,7 +355,7 @@ <h5 class="h5-parameters">Parameters:</h5>
 
 
 
-            <td class="description last"><p>The function that is executed when the promise settles</p></td>
+            <td class="description last"><p>The function that is executed when the promise rejects</p></td>
         </tr>
 
 
@@ -376,7 +401,7 @@ <h4 class="name" id=".setMaxConcurrency"><span class="type-signature type-signat
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line40">line 40</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line51">line 51</a>
     </li></ul></dd>
 
 
@@ -495,7 +520,7 @@ <h5 class="h5-parameters">Parameters:</h5>
 
 
 
-    <h4 class="name" id=".setPromiseTimeout"><span class="type-signature type-signature-static">(static) </span>setPromiseTimeout<span class="signature">(timeout)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id=".setMaxRetries"><span class="type-signature type-signature-static">(static) </span>setMaxRetries<span class="signature">(maxRetries)</span><span class="type-signature"></span></h4>
 
 
 
@@ -505,14 +530,14 @@ <h4 class="name" id=".setPromiseTimeout"><span class="type-signature type-signat
 <dl class="details">
 
     <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li><p>Set the max amount of time a promise can take to settle
-By default the queue will not monitor the promise time to settle</p></li></ul></dd>
+    <dd class="tag-description"><ul class="dummy"><li><p>Set the max amount of times a promise can be retried after a failure
+By default the queue will not retry a failed promise.</p></li></ul></dd>
 
 
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line103">line 103</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line85">line 85</a>
     </li></ul></dd>
 
 
@@ -544,13 +569,6 @@ <h4 class="name" id=".setPromiseTimeout"><span class="type-signature type-signat
 
 
 
-    
-    <dt class="tag-todo">To Do:</dt>
-    <dd class="tag-todo">
-        <ul>
-            <li>implement abort controller to kill promise when timeout is reached</li>
-        </ul>
-    </dd>
 
 </dl>
 
@@ -568,23 +586,25 @@ <h5 class="h5-examples">Example</h5>
 
     <pre class="prettyprint"><code>const queue = new Queue()
 
-//setting timeout for promises to 100ms
-queue.setPromiseTimeout(100)
+//setting retries to 3
+queue.setRetries(3)
 
-//function returns the promise we want to add to queue
 const pets = () =>{
-  return new Promise((resolve) =>{
-    setTimeout(resolve, 500) //note that the timeout in the promise is larger than the set promise timeout
+  return new Promise((resolve, reject) =>{
+    setTimeout(reject('rejected'), 100)
   })
 }
 
-//the callback that is ran on the settlement of the promise
-const callback = (res, err) => {
-console.log(err) //output: "Request timed out"
+const callback = (res) => {
+  //do something with data
 }
 
-//Adding the promise to the queue
-queue.add(pets, callback)</code></pre>
+const errCallback = ( err) => {
+  console.log(err.message) // output: 'max retries reached'
+  console.log(err.errors) //  output: list of errors
+}
+
+queue.add(pets, callback, errCallback)</code></pre>
 
 
 
@@ -614,7 +634,7 @@ <h5 class="h5-parameters">Parameters:</h5>
 
         <tr>
 
-                <td class="name"><code>timeout</code></td>
+                <td class="name"><code>maxRetries</code></td>
 
 
             <td class="type">
@@ -631,7 +651,7 @@ <h5 class="h5-parameters">Parameters:</h5>
 
 
 
-            <td class="description last"><p>The max amount of time in ms a promise can take to settle</p></td>
+            <td class="description last"><p>The max amount of promises to run concurrently</p></td>
         </tr>
 
 
@@ -661,7 +681,7 @@ <h5 class="h5-parameters">Parameters:</h5>
 
 
 
-    <h4 class="name" id=".setRetries"><span class="type-signature type-signature-static">(static) </span>setRetries<span class="signature">(maxRetries)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id=".setPromiseTimeout"><span class="type-signature type-signature-static">(static) </span>setPromiseTimeout<span class="signature">(timeout)</span><span class="type-signature"></span></h4>
 
 
 
@@ -671,14 +691,15 @@ <h4 class="name" id=".setRetries"><span class="type-signature type-signature-sta
 <dl class="details">
 
     <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li><p>Set the max amount of times a promise can be retried after a failure
-By default the queue will not retry a failed promise.</p></li></ul></dd>
+    <dd class="tag-description"><ul class="dummy"><li><p>Set the max amount of time a promise can take to settle
+By default the queue will not monitor the promise time to settle
+a signal must be handled in the promise for the timeout to abort the promise</p></li></ul></dd>
 
 
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line70">line 70</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line131">line 131</a>
     </li></ul></dd>
 
 
@@ -710,6 +731,13 @@ <h4 class="name" id=".setRetries"><span class="type-signature type-signature-sta
 
 
 
+    
+    <dt class="tag-todo">To Do:</dt>
+    <dd class="tag-todo">
+        <ul>
+            <li>implement abort controller to kill promise when timeout is reached</li>
+        </ul>
+    </dd>
 
 </dl>
 
@@ -727,21 +755,31 @@ <h5 class="h5-examples">Example</h5>
 
     <pre class="prettyprint"><code>const queue = new Queue()
 
-//setting retries to 3
-queue.setRetries(3)
+//setting timeout for promises to 100ms
+queue.setPromiseTimeout(100)
 
-const pets = () =>{
+//function returns the promise we want to add to queue
+const pets = (signal) =>{
   return new Promise((resolve, reject) =>{
-    setTimeout(reject('rejected'), 100)
+  signal.addEventListener("abort", () => {
+   reject("Aborted")
+  }
+    setTimeout(resolve, 500) //note that the timeout in the promise is larger than the set promise timeout
   })
 }
 
-const callback = (res, err) => {
-  console.log(err.message) // output: 'max retries reached'
-  console.log(err.cause) //  output: ['rejected', 'rejected', 'rejected']
+//the callback that is ran on the resolution of the promise
+const callback = (res ) => {
+  //do something with data
+}
+
+//the callback that is ran on the rejection of the promise
+const errCallback = (err) => {
+console.log(err) //output: "Request timed out"
 }
 
-queue.add(pets, callback)</code></pre>
+//Adding the promise to the queue
+queue.add(pets, callback, errCallback)</code></pre>
 
 
 
@@ -771,7 +809,7 @@ <h5 class="h5-parameters">Parameters:</h5>
 
         <tr>
 
-                <td class="name"><code>maxRetries</code></td>
+                <td class="name"><code>timeout</code></td>
 
 
             <td class="type">
@@ -788,7 +826,7 @@ <h5 class="h5-parameters">Parameters:</h5>
 
 
 
-            <td class="description last"><p>The max amount of promises to run concurrently</p></td>
+            <td class="description last"><p>The max amount of time in ms a promise can take to settle</p></td>
         </tr>
 
 
@@ -833,7 +871,7 @@ <h5 class="h5-parameters">Parameters:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Nov 14 2024 23:29:04 GMT+0200 (South Africa Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Tue Nov 26 2024 17:05:18 GMT+0200 (South Africa Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>