refactor: queuers instead of plain queue, new queue function

Author: KevinVandy

docs/config.json

@@ -323,10 +323,6 @@
       "defaultCollapsed": true,
       "label": "Queue API Reference",
       "children": [
-        {
-          "label": "QueueOptions",
-          "to": "reference/interfaces/queueoptions"
-        },
         {
           "label": "QueuerOptions",
           "to": "reference/interfaces/queueroptions"
@@ -335,10 +331,6 @@
           "label": "AsyncQueuerOptions",
           "to": "reference/interfaces/asyncqueueroptions"
         },
-        {
-          "label": "Queue",
-          "to": "reference/classes/queue"
-        },
         {
           "label": "Queuer",
           "to": "reference/classes/queuer"
@@ -352,14 +344,6 @@
         {
           "label": "react",
           "children": [
-            {
-              "label": "useQueue",
-              "to": "framework/react/reference/functions/usequeue"
-            },
-            {
-              "label": "useQueueState",
-              "to": "framework/react/reference/functions/usequeuestate"
-            },
             {
               "label": "useQueuer",
               "to": "framework/react/reference/functions/usequeuer"
@@ -387,14 +371,6 @@
               "label": "queue",
               "to": "framework/react/examples/queue"
             },
-            {
-              "label": "useQueue",
-              "to": "framework/react/examples/useQueue"
-            },
-            {
-              "label": "useQueueState",
-              "to": "framework/react/examples/useQueueState"
-            },
             {
               "label": "useQueuer",
               "to": "framework/react/examples/useQueuer"

docs/framework/react/reference/functions/useasyncqueuer.md

@@ -51,13 +51,13 @@ The hook returns an object containing methods to:
 addItem: (fn, position?) => Promise<TValue>;
 ```
 
-Adds a task to the queue
+Adds a task to the queuer
 
 #### Parameters
 
 ##### fn
 
-() => `TValue` \| `Promise`\<`TValue`\>
+() => `Promise`\<`TValue`\>
 
 ##### position?
 
@@ -73,7 +73,7 @@ Adds a task to the queue
 clear: () => void;
 ```
 
-Removes all items from the queue
+Removes all items from the queuer
 
 #### Returns
 
@@ -82,38 +82,34 @@ Removes all items from the queue
 ### getActiveItems()
 
 ```ts
-getActiveItems: () => () => Promise<any>[];
+getActiveItems: () => () => Promise<TValue>[];
 ```
 
 Returns the active items
 
 #### Returns
 
-() => `Promise`\<`any`\>[]
-
-The active items
+() => `Promise`\<`TValue`\>[]
 
 ### getAllItems()
 
 ```ts
-getAllItems: () => () => Promise<any>[];
+getAllItems: () => () => Promise<TValue>[];
 ```
 
-Returns all items (active and pending)
+Returns a copy of all items in the queuer
 
 #### Returns
 
-() => `Promise`\<`any`\>[]
-
-All items
+() => `Promise`\<`TValue`\>[]
 
 ### getExecutionCount()
 
 ```ts
 getExecutionCount: () => number;
 ```
 
-Returns the number of items that have been removed from the queue
+Returns the number of items that have been removed from the queuer
 
 #### Returns
 
@@ -125,27 +121,18 @@ Returns the number of items that have been removed from the queue
 getNextItem: (position?) => undefined | () => Promise<TValue>;
 ```
 
-Removes and returns an item from the queue using shift (default) or pop
+Removes and returns an item from the queuer
 
 #### Parameters
 
 ##### position?
 
-`QueuePosition`
+`"front"` | `"back"`
 
 #### Returns
 
 `undefined` \| () => `Promise`\<`TValue`\>
 
-#### Example
-
-```ts
-// Standard FIFO queue
-queue.getNextItem()
-// Stack-like behavior (LIFO)
-queue.getNextItem('back')
-```
-
 ### getPendingItems()
 
 ```ts
@@ -158,15 +145,13 @@ Returns the pending items
 
 () => `Promise`\<`TValue`\>[]
 
-The pending items
-
 ### isEmpty()
 
 ```ts
 isEmpty: () => boolean;
 ```
 
-Returns true if the queue is empty
+Returns true if the queuer is empty
 
 #### Returns
 
@@ -178,7 +163,7 @@ Returns true if the queue is empty
 isFull: () => boolean;
 ```
 
-Returns true if the queue is full
+Returns true if the queuer is full
 
 #### Returns
 
@@ -190,7 +175,7 @@ Returns true if the queue is full
 isIdle: () => boolean;
 ```
 
-Returns true if all items are settled
+Returns true if the queuer is running but has no items to process
 
 #### Returns
 
@@ -220,7 +205,7 @@ Adds a callback to be called when a task errors
 
 ##### cb
 
-(`error`, `task`) => `void`
+(`error`) => `void`
 
 #### Returns
 
@@ -242,7 +227,7 @@ Adds a callback to be called when a task is settled
 
 ##### cb
 
-() => `void`
+(`result`) => `void`
 
 #### Returns
 
@@ -264,29 +249,7 @@ Adds a callback to be called when a task succeeds
 
 ##### cb
 
-(`result`, `task`) => `void`
-
-#### Returns
-
-`Function`
-
-##### Returns
-
-`void`
-
-### onUpdate()
-
-```ts
-onUpdate: (cb) => () => void;
-```
-
-Adds a callback to be called when an item is processed
-
-#### Parameters
-
-##### cb
-
-(`item`) => `void`
+(`result`) => `void`
 
 #### Returns
 
@@ -308,28 +271,19 @@ Returns an item without removing it
 
 ##### position?
 
-`QueuePosition`
+`"front"` | `"back"`
 
 #### Returns
 
 `undefined` \| () => `Promise`\<`TValue`\>
 
-#### Example
-
-```ts
-// Look at next item to getNextItem
-queue.peek()
-// Look at last item (like stack top)
-queue.peek('back')
-```
-
 ### reset()
 
 ```ts
 reset: (withInitialItems?) => void;
 ```
 
-Resets the queue to its initial state
+Resets the queuer to its initial state
 
 #### Parameters
 
@@ -347,7 +301,7 @@ Resets the queue to its initial state
 size: () => number;
 ```
 
-Returns the current size of the queue
+Returns the current size of the queuer
 
 #### Returns
 
@@ -365,8 +319,6 @@ Starts the queuer and processes items
 
 `Promise`\<`void`\>
 
-A promise that resolves when the queuer is settled
-
 ### stop()
 
 ```ts

docs/framework/react/reference/functions/useasyncqueuerstate.md

@@ -11,8 +11,8 @@ title: useAsyncQueuerState
 function useAsyncQueuerState<TValue>(options): readonly [() => Promise<TValue>[], {
   addItem: (fn, position?) => Promise<TValue>;
   clear: () => void;
-  getActiveItems: () => () => Promise<any>[];
-  getAllItems: () => () => Promise<any>[];
+  getActiveItems: () => () => Promise<TValue>[];
+  getAllItems: () => () => Promise<TValue>[];
   getExecutionCount: () => number;
   getNextItem: (position?) => undefined | () => Promise<TValue>;
   getPendingItems: () => () => Promise<TValue>[];
@@ -23,7 +23,6 @@ function useAsyncQueuerState<TValue>(options): readonly [() => Promise<TValue>[]
   onError: (cb) => () => void;
   onSettled: (cb) => () => void;
   onSuccess: (cb) => () => void;
-  onUpdate: (cb) => () => void;
   peek: (position?) => undefined | () => Promise<TValue>;
   reset: (withInitialItems?) => void;
   size: () => number;
@@ -69,8 +68,8 @@ The state will automatically update whenever items are:
 readonly \[() => `Promise`\<`TValue`\>[], \{
   `addItem`: (`fn`, `position`?) => `Promise`\<`TValue`\>;
   `clear`: () => `void`;
-  `getActiveItems`: () => () => `Promise`\<`any`\>[];
-  `getAllItems`: () => () => `Promise`\<`any`\>[];
+  `getActiveItems`: () => () => `Promise`\<`TValue`\>[];
+  `getAllItems`: () => () => `Promise`\<`TValue`\>[];
   `getExecutionCount`: () => `number`;
   `getNextItem`: (`position`?) => `undefined` \| () => `Promise`\<`TValue`\>;
   `getPendingItems`: () => () => `Promise`\<`TValue`\>[];
@@ -81,7 +80,6 @@ readonly \[() => `Promise`\<`TValue`\>[], \{
   `onError`: (`cb`) => () => `void`;
   `onSettled`: (`cb`) => () => `void`;
   `onSuccess`: (`cb`) => () => `void`;
-  `onUpdate`: (`cb`) => () => `void`;
   `peek`: (`position`?) => `undefined` \| () => `Promise`\<`TValue`\>;
   `reset`: (`withInitialItems`?) => `void`;
   `size`: () => `number`;