add getPriority function back to async queuer

Author: KevinVandy

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

@@ -57,7 +57,7 @@ Adds a task to the queuer
 
 ##### fn
 
-() => `Promise`\<`TValue`\>
+() => `Promise`\<`TValue`\> & `object`
 
 ##### position?
 
@@ -275,7 +275,7 @@ Returns an item without removing it
 
 ##### position?
 
-`"front"` | `"back"`
+`QueuePosition`
 
 #### Returns
 

docs/guides/async-queueing.md

@@ -152,8 +152,9 @@ stack.addItem(async () => 'second') // [first, second]
 
 #### Priority Queue
 
-Priority queues process tasks based on their assigned priority values, ensuring important tasks are handled first:
+Priority queues process tasks based on their assigned priority values, ensuring important tasks are handled first. There are two ways to specify priorities:
 
+1. Static priority values attached to tasks:
 ```ts
 const priorityQueue = new AsyncQueuer<string>({
   concurrency: 2
@@ -182,6 +183,36 @@ priorityQueue.addItem(mediumPriorityTask)
 // Processes: high and medium concurrently, then low
 ```
 
+2. Dynamic priority calculation using `getPriority` option:
+```ts
+const dynamicPriorityQueue = new AsyncQueuer<string>({
+  concurrency: 2,
+  getPriority: (task) => {
+    // Calculate priority based on task properties or other factors
+    // Higher numbers have priority
+    return calculateTaskPriority(task)
+  }
+})
+
+// Add tasks - priority will be calculated dynamically
+dynamicPriorityQueue.addItem(async () => {
+  const result = await processTask('low')
+  return result
+})
+
+dynamicPriorityQueue.addItem(async () => {
+  const result = await processTask('high')
+  return result
+})
+```
+
+Priority queues are essential when:
+- Tasks have different importance levels
+- Critical operations need to run first
+- You need flexible task ordering based on priority
+- Resource allocation should favor important tasks
+- Priority needs to be determined dynamically based on task properties or external factors
+
 ### Error Handling
 
 The AsyncQueuer provides comprehensive error handling capabilities to ensure robust task processing. You can handle errors at both the queue level and individual task level:

docs/reference/classes/asyncqueuer.md

@@ -7,7 +7,7 @@ title: AsyncQueuer
 
 # Class: AsyncQueuer\<TValue\>
 
-Defined in: [async-queuer.ts:94](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L94)
+Defined in: [async-queuer.ts:95](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L95)
 
 A flexible asynchronous queuer that processes tasks with configurable concurrency control.
 
@@ -50,7 +50,7 @@ queuer.onSuccess((result) => {
 new AsyncQueuer<TValue>(initialOptions): AsyncQueuer<TValue>
 ```
 
-Defined in: [async-queuer.ts:105](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L105)
+Defined in: [async-queuer.ts:106](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L106)
 
 #### Parameters
 
@@ -70,7 +70,7 @@ Defined in: [async-queuer.ts:105](https://github.com/TanStack/pacer/blob/main/pa
 protected options: Required<AsyncQueuerOptions<TValue>>;
 ```
 
-Defined in: [async-queuer.ts:95](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L95)
+Defined in: [async-queuer.ts:96](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L96)
 
 ## Methods
 
@@ -83,15 +83,15 @@ addItem(
 runOnUpdate): Promise<TValue>
 ```
 
-Defined in: [async-queuer.ts:183](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L183)
+Defined in: [async-queuer.ts:184](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L184)
 
 Adds a task to the queuer
 
 #### Parameters
 
 ##### fn
 
-() => `Promise`\<`TValue`\>
+() => `Promise`\<`TValue`\> & `object`
 
 ##### position
 
@@ -113,7 +113,7 @@ Adds a task to the queuer
 clear(): void
 ```
 
-Defined in: [async-queuer.ts:294](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L294)
+Defined in: [async-queuer.ts:305](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L305)
 
 Removes all items from the queuer
 
@@ -129,7 +129,7 @@ Removes all items from the queuer
 getActiveItems(): () => Promise<TValue>[]
 ```
 
-Defined in: [async-queuer.ts:328](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L328)
+Defined in: [async-queuer.ts:339](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L339)
 
 Returns the active items
 
@@ -145,7 +145,7 @@ Returns the active items
 getAllItems(): () => Promise<TValue>[]
 ```
 
-Defined in: [async-queuer.ts:314](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L314)
+Defined in: [async-queuer.ts:325](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L325)
 
 Returns a copy of all items in the queuer
 
@@ -161,7 +161,7 @@ Returns a copy of all items in the queuer
 getExecutionCount(): number
 ```
 
-Defined in: [async-queuer.ts:321](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L321)
+Defined in: [async-queuer.ts:332](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L332)
 
 Returns the number of items that have been removed from the queuer
 
@@ -177,7 +177,7 @@ Returns the number of items that have been removed from the queuer
 getNextItem(position): undefined | () => Promise<TValue>
 ```
 
-Defined in: [async-queuer.ts:239](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L239)
+Defined in: [async-queuer.ts:252](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L252)
 
 Removes and returns an item from the queuer
 
@@ -199,7 +199,7 @@ Removes and returns an item from the queuer
 getPendingItems(): () => Promise<TValue>[]
 ```
 
-Defined in: [async-queuer.ts:335](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L335)
+Defined in: [async-queuer.ts:346](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L346)
 
 Returns the pending items
 
@@ -215,7 +215,7 @@ Returns the pending items
 isEmpty(): boolean
 ```
 
-Defined in: [async-queuer.ts:273](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L273)
+Defined in: [async-queuer.ts:284](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L284)
 
 Returns true if the queuer is empty
 
@@ -231,7 +231,7 @@ Returns true if the queuer is empty
 isFull(): boolean
 ```
 
-Defined in: [async-queuer.ts:280](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L280)
+Defined in: [async-queuer.ts:291](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L291)
 
 Returns true if the queuer is full
 
@@ -247,7 +247,7 @@ Returns true if the queuer is full
 isIdle(): boolean
 ```
 
-Defined in: [async-queuer.ts:411](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L411)
+Defined in: [async-queuer.ts:422](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L422)
 
 Returns true if the queuer is running but has no items to process
 
@@ -263,7 +263,7 @@ Returns true if the queuer is running but has no items to process
 isRunning(): boolean
 ```
 
-Defined in: [async-queuer.ts:404](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L404)
+Defined in: [async-queuer.ts:415](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L415)
 
 Returns true if the queuer is running
 
@@ -279,7 +279,7 @@ Returns true if the queuer is running
 onError(cb): () => void
 ```
 
-Defined in: [async-queuer.ts:352](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L352)
+Defined in: [async-queuer.ts:363](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L363)
 
 Adds a callback to be called when a task errors
 
@@ -305,7 +305,7 @@ Adds a callback to be called when a task errors
 onSettled(cb): () => void
 ```
 
-Defined in: [async-queuer.ts:362](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L362)
+Defined in: [async-queuer.ts:373](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L373)
 
 Adds a callback to be called when a task is settled
 
@@ -331,7 +331,7 @@ Adds a callback to be called when a task is settled
 onSuccess(cb): () => void
 ```
 
-Defined in: [async-queuer.ts:342](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L342)
+Defined in: [async-queuer.ts:353](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L353)
 
 Adds a callback to be called when a task succeeds
 
@@ -357,15 +357,15 @@ Adds a callback to be called when a task succeeds
 peek(position): undefined | () => Promise<TValue>
 ```
 
-Defined in: [async-queuer.ts:261](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L261)
+Defined in: [async-queuer.ts:274](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L274)
 
 Returns an item without removing it
 
 #### Parameters
 
 ##### position
 
-`"front"` | `"back"`
+[`QueuePosition`](../type-aliases/queueposition.md) = `'front'`
 
 #### Returns
 
@@ -379,7 +379,7 @@ Returns an item without removing it
 reset(withInitialItems?): void
 ```
 
-Defined in: [async-queuer.ts:302](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L302)
+Defined in: [async-queuer.ts:313](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L313)
 
 Resets the queuer to its initial state
 
@@ -401,7 +401,7 @@ Resets the queuer to its initial state
 setOptions(newOptions): AsyncQueuerOptions<TValue>
 ```
 
-Defined in: [async-queuer.ts:120](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L120)
+Defined in: [async-queuer.ts:121](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L121)
 
 Updates the queuer options
 Returns the new options state
@@ -424,7 +424,7 @@ Returns the new options state
 size(): number
 ```
 
-Defined in: [async-queuer.ts:287](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L287)
+Defined in: [async-queuer.ts:298](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L298)
 
 Returns the current size of the queuer
 
@@ -440,7 +440,7 @@ Returns the current size of the queuer
 start(): Promise<void>
 ```
 
-Defined in: [async-queuer.ts:372](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L372)
+Defined in: [async-queuer.ts:383](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L383)
 
 Starts the queuer and processes items
 
@@ -456,7 +456,7 @@ Starts the queuer and processes items
 stop(): void
 ```
 
-Defined in: [async-queuer.ts:395](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L395)
+Defined in: [async-queuer.ts:406](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L406)
 
 Stops the queuer from processing items
 
@@ -472,7 +472,7 @@ Stops the queuer from processing items
 protected tick(): void
 ```
 
-Defined in: [async-queuer.ts:130](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L130)
+Defined in: [async-queuer.ts:131](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L131)
 
 Processes items in the queuer
 

docs/reference/functions/asyncqueue.md

@@ -11,7 +11,7 @@ title: asyncQueue
 function asyncQueue<TValue>(options): (fn, position, runOnUpdate) => Promise<TValue>
 ```
 
-Defined in: [async-queuer.ts:433](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L433)
+Defined in: [async-queuer.ts:444](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L444)
 
 Creates a new AsyncQueuer instance with the given options and returns a bound addItem function.
 The queuer is automatically started and ready to process items.
@@ -40,7 +40,7 @@ Adds a task to the queuer
 
 #### fn
 
-() => `Promise`\<`TValue`\>
+() => `Promise`\<`TValue`\> & `object`
 
 #### position
 

docs/reference/interfaces/asyncqueueroptions.md

@@ -69,10 +69,11 @@ Default position to get items from during processing
 optional getPriority: (item) => number;
 ```
 
-Defined in: [async-queuer.ts:22](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L22)
+Defined in: [async-queuer.ts:23](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L23)
 
 Function to determine priority of items in the queuer
 Higher priority items will be processed first
+If not provided, will use static priority values attached to tasks
 
 #### Parameters
 
@@ -89,17 +90,13 @@ Higher priority items will be processed first
 ### initialItems?
 
 ```ts
-optional initialItems: () => Promise<TValue>[];
+optional initialItems: () => Promise<TValue> & object[];
 ```
 
-Defined in: [async-queuer.ts:26](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L26)
+Defined in: [async-queuer.ts:27](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L27)
 
 Initial items to populate the queuer with
 
-#### Returns
-
-`Promise`\<`TValue`\>
-
 ***
 
 ### maxSize?
@@ -108,7 +105,7 @@ Initial items to populate the queuer with
 optional maxSize: number;
 ```
 
-Defined in: [async-queuer.ts:30](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L30)
+Defined in: [async-queuer.ts:31](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L31)
 
 Maximum number of items allowed in the queuer
 
@@ -120,7 +117,7 @@ Maximum number of items allowed in the queuer
 optional onGetNextItem: (item, queuer) => void;
 ```
 
-Defined in: [async-queuer.ts:34](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L34)
+Defined in: [async-queuer.ts:35](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L35)
 
 Callback fired whenever an item is removed from the queuer
 
@@ -146,7 +143,7 @@ Callback fired whenever an item is removed from the queuer
 optional onUpdate: (queuer) => void;
 ```
 
-Defined in: [async-queuer.ts:41](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L41)
+Defined in: [async-queuer.ts:42](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L42)
 
 Callback fired whenever an item is added or removed from the queuer
 
@@ -168,7 +165,7 @@ Callback fired whenever an item is added or removed from the queuer
 optional started: boolean;
 ```
 
-Defined in: [async-queuer.ts:45](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L45)
+Defined in: [async-queuer.ts:46](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L46)
 
 Whether the queuer should start processing tasks immediately
 
@@ -180,6 +177,6 @@ Whether the queuer should start processing tasks immediately
 optional wait: number;
 ```
 
-Defined in: [async-queuer.ts:49](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L49)
+Defined in: [async-queuer.ts:50](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L50)
 
 Time in milliseconds to wait between processing items