@tanstack/pacer 0.22.0 → 0.23.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/dist/async-batcher.d.ts +11 -13
- package/dist/async-batcher.js +185 -131
- package/dist/async-debouncer.d.ts +6 -8
- package/dist/async-debouncer.js +186 -142
- package/dist/async-queuer.d.ts +11 -13
- package/dist/async-queuer.js +383 -290
- package/dist/async-rate-limiter.d.ts +6 -8
- package/dist/async-rate-limiter.js +197 -143
- package/dist/async-retryer.d.ts +6 -8
- package/dist/async-retryer.js +209 -179
- package/dist/async-throttler.d.ts +6 -8
- package/dist/async-throttler.js +214 -157
- package/dist/batcher.d.ts +5 -7
- package/dist/batcher.js +107 -87
- package/dist/debouncer.d.ts +6 -8
- package/dist/debouncer.js +99 -86
- package/dist/event-client.d.ts +8 -10
- package/dist/event-client.js +1 -2
- package/dist/queuer.d.ts +7 -9
- package/dist/queuer.js +277 -212
- package/dist/rate-limiter.d.ts +6 -8
- package/dist/rate-limiter.js +127 -109
- package/dist/throttler.d.ts +6 -8
- package/dist/throttler.js +127 -90
- package/dist/types.d.ts +4 -6
- package/dist/utils.d.ts +3 -5
- package/dist/utils.js +1 -2
- package/package.json +21 -68
- package/dist/async-batcher.cjs +0 -337
- package/dist/async-batcher.cjs.map +0 -1
- package/dist/async-batcher.d.cts +0 -343
- package/dist/async-batcher.js.map +0 -1
- package/dist/async-debouncer.cjs +0 -327
- package/dist/async-debouncer.cjs.map +0 -1
- package/dist/async-debouncer.d.cts +0 -299
- package/dist/async-debouncer.js.map +0 -1
- package/dist/async-queuer.cjs +0 -516
- package/dist/async-queuer.cjs.map +0 -1
- package/dist/async-queuer.d.cts +0 -440
- package/dist/async-queuer.js.map +0 -1
- package/dist/async-rate-limiter.cjs +0 -370
- package/dist/async-rate-limiter.cjs.map +0 -1
- package/dist/async-rate-limiter.d.cts +0 -356
- package/dist/async-rate-limiter.js.map +0 -1
- package/dist/async-retryer.cjs +0 -365
- package/dist/async-retryer.cjs.map +0 -1
- package/dist/async-retryer.d.cts +0 -321
- package/dist/async-retryer.js.map +0 -1
- package/dist/async-throttler.cjs +0 -344
- package/dist/async-throttler.cjs.map +0 -1
- package/dist/async-throttler.d.cts +0 -319
- package/dist/async-throttler.js.map +0 -1
- package/dist/batcher.cjs +0 -200
- package/dist/batcher.cjs.map +0 -1
- package/dist/batcher.d.cts +0 -179
- package/dist/batcher.js.map +0 -1
- package/dist/debouncer.cjs +0 -203
- package/dist/debouncer.cjs.map +0 -1
- package/dist/debouncer.d.cts +0 -166
- package/dist/debouncer.js.map +0 -1
- package/dist/event-client.cjs +0 -64
- package/dist/event-client.cjs.map +0 -1
- package/dist/event-client.d.cts +0 -65
- package/dist/event-client.js.map +0 -1
- package/dist/index.cjs +0 -52
- package/dist/index.d.cts +0 -15
- package/dist/queuer.cjs +0 -406
- package/dist/queuer.cjs.map +0 -1
- package/dist/queuer.d.cts +0 -345
- package/dist/queuer.js.map +0 -1
- package/dist/rate-limiter.cjs +0 -263
- package/dist/rate-limiter.cjs.map +0 -1
- package/dist/rate-limiter.d.cts +0 -214
- package/dist/rate-limiter.js.map +0 -1
- package/dist/throttler.cjs +0 -215
- package/dist/throttler.cjs.map +0 -1
- package/dist/throttler.d.cts +0 -206
- package/dist/throttler.js.map +0 -1
- package/dist/types.cjs +0 -0
- package/dist/types.d.cts +0 -13
- package/dist/utils.cjs +0 -13
- package/dist/utils.cjs.map +0 -1
- package/dist/utils.d.cts +0 -7
- package/dist/utils.js.map +0 -1
- package/src/async-batcher.ts +0 -594
- package/src/async-debouncer.ts +0 -566
- package/src/async-queuer.ts +0 -988
- package/src/async-rate-limiter.ts +0 -648
- package/src/async-retryer.ts +0 -673
- package/src/async-throttler.ts +0 -634
- package/src/batcher.ts +0 -329
- package/src/debouncer.ts +0 -334
- package/src/event-client.ts +0 -129
- package/src/index.ts +0 -24
- package/src/queuer.ts +0 -751
- package/src/rate-limiter.ts +0 -429
- package/src/throttler.ts +0 -380
- package/src/types.ts +0 -12
- package/src/utils.ts +0 -12
package/dist/queuer.cjs.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"queuer.cjs","names":["Store","parseFunctionOrValue","#setState","#checkExpiredItems","#getWait","#timeoutId","#tick","#clearTimeout","#getAllItems"],"sources":["../src/queuer.ts"],"sourcesContent":["import { Store } from '@tanstack/store'\nimport { parseFunctionOrValue } from './utils'\nimport { emitChange, pacerEventClient } from './event-client'\n\nexport interface QueuerState<TValue> {\n /**\n * Number of times addItem has been called (for reduction calculations)\n */\n addItemCount: number\n /**\n * Number of items that have been processed by the queuer\n */\n executionCount: number\n /**\n * Number of items that have been removed from the queue due to expiration\n */\n expirationCount: number\n /**\n * Whether the queuer has no items to process (items array is empty)\n */\n isEmpty: boolean\n /**\n * Whether the queuer has reached its maximum capacity\n */\n isFull: boolean\n /**\n * Whether the queuer is not currently processing any items\n */\n isIdle: boolean\n /**\n * Whether the queuer is active and will process items automatically\n */\n isRunning: boolean\n /**\n * Array of items currently waiting to be processed\n */\n items: Array<TValue>\n /**\n * Timestamps when items were added to the queue for expiration tracking\n */\n itemTimestamps: Array<number>\n /**\n * Whether the queuer has a pending timeout for processing the next item\n */\n pendingTick: boolean\n /**\n * Number of items that have been rejected from being added to the queue\n */\n rejectionCount: number\n /**\n * Number of items currently in the queue\n */\n size: number\n /**\n * Current processing status - 'idle' when not processing, 'running' when active, 'stopped' when paused\n */\n status: 'idle' | 'running' | 'stopped'\n}\n\nfunction getDefaultQueuerState<TValue>(): QueuerState<TValue> {\n return {\n executionCount: 0,\n expirationCount: 0,\n isEmpty: true,\n isFull: false,\n isIdle: true,\n isRunning: true,\n itemTimestamps: [],\n items: [],\n pendingTick: false,\n rejectionCount: 0,\n size: 0,\n status: 'idle',\n addItemCount: 0,\n }\n}\n\n/**\n * Options for configuring a Queuer instance.\n *\n * These options control queue behavior, item expiration, callbacks, and more.\n */\nexport interface QueuerOptions<TValue> {\n /**\n * Default position to add items to the queuer\n * @default 'back'\n */\n addItemsTo?: QueuePosition\n /**\n * Maximum time in milliseconds that an item can stay in the queue\n * If not provided, items will never expire\n */\n expirationDuration?: number\n /**\n * Function to determine if an item has expired\n * If provided, this overrides the expirationDuration behavior\n */\n getIsExpired?: (item: TValue, addedAt: number) => boolean\n /**\n * Default position to get items from during processing\n * @default 'front'\n */\n getItemsFrom?: QueuePosition\n /**\n * Function to determine priority of items in the queuer\n * Higher priority items will be processed first\n */\n getPriority?: (item: TValue) => number\n /**\n * Initial items to populate the queuer with\n */\n initialItems?: Array<TValue>\n /**\n * Initial state for the queuer\n */\n initialState?: Partial<QueuerState<TValue>>\n /**\n * Optional key to identify this queuer instance.\n * If provided, the queuer will be identified by this key in the devtools and PacerProvider if applicable.\n */\n key?: string\n /**\n * Maximum number of items allowed in the queuer\n */\n maxSize?: number\n /**\n * Callback fired whenever an item is removed from the queuer\n */\n onExecute?: (item: TValue, queuer: Queuer<TValue>) => void\n /**\n * Callback fired whenever an item expires in the queuer\n */\n onExpire?: (item: TValue, queuer: Queuer<TValue>) => void\n /**\n * Callback fired whenever an item is added or removed from the queuer\n */\n onItemsChange?: (queuer: Queuer<TValue>) => void\n /**\n * Callback fired whenever an item is rejected from being added to the queuer\n */\n onReject?: (item: TValue, queuer: Queuer<TValue>) => void\n /**\n * Whether the queuer should start processing tasks immediately\n */\n started?: boolean\n /**\n * Time in milliseconds to wait between processing items.\n * Can be a number or a function that returns a number.\n * @default 0\n */\n wait?: number | ((queuer: Queuer<TValue>) => number)\n}\n\n/**\n * Utility function for sharing common `QueuerOptions` options between different `Queuer` instances.\n */\nexport function queuerOptions<\n TValue = any,\n TOptions extends Partial<QueuerOptions<TValue>> = Partial<\n QueuerOptions<TValue>\n >,\n>(options: TOptions): TOptions {\n return options\n}\n\nconst defaultOptions: Omit<\n Required<QueuerOptions<any>>,\n | 'initialState'\n | 'onExecute'\n | 'onIsRunningChange'\n | 'onItemsChange'\n | 'onReject'\n | 'onExpire'\n | 'key'\n> = {\n addItemsTo: 'back',\n getItemsFrom: 'front',\n getPriority: (item) => item?.priority ?? 0,\n getIsExpired: () => false,\n expirationDuration: Infinity,\n initialItems: [],\n maxSize: Infinity,\n started: true,\n wait: 0,\n}\n\n/**\n * Position type for addItem and getNextItem operations.\n *\n * - 'front': Operate on the front of the queue (FIFO)\n * - 'back': Operate on the back of the queue (LIFO)\n */\nexport type QueuePosition = 'front' | 'back'\n\n/**\n * A flexible queue that processes items with configurable wait times, expiration, and priority.\n *\n * This synchronous version is lighter weight and often all you need - upgrade to AsyncQueuer when you need promises, retry support, abort capabilities, concurrent execution, or advanced error handling.\n *\n * Features:\n * - Automatic or manual processing of items\n * - FIFO (First In First Out), LIFO (Last In First Out), or double-ended queue behavior\n * - Priority-based ordering when getPriority is provided\n * - Item expiration and removal of stale items\n * - Callbacks for queue state changes, execution, rejection, and expiration\n *\n * Running behavior:\n * - `start()`: Begins automatically processing items in the queue (defaults to isRunning)\n * - `stop()`: Pauses processing but maintains queue state\n * - `wait`: Configurable delay between processing items\n * - `onItemsChange`/`onExecute`: Callbacks for monitoring queue state\n *\n * Manual processing is also supported when automatic processing is disabled:\n * - `execute()`: Processes the next item using the provided function\n * - `getNextItem()`: Removes and returns the next item without processing\n *\n * Queue behavior defaults to FIFO:\n * - `addItem(item)`: Adds to the back of the queue\n * - Items processed from the front of the queue\n *\n * Priority queue:\n * - Provide a `getPriority` function; higher values are processed first\n *\n * Stack (LIFO):\n * - `addItem(item, 'back')`: Adds to the back\n * - `getNextItem('back')`: Removes from the back\n *\n * Double-ended queue:\n * - `addItem(item, position)`: Adds to specified position ('front'/'back')\n * - `getNextItem(position)`: Removes from specified position\n *\n * Item expiration:\n * - `expirationDuration`: Maximum time items can stay in the queue\n * - `getIsExpired`: Function to override default expiration\n * - `onExpire`: Callback for expired items\n *\n * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the queuer\n * - Use `onExecute` callback to react to item execution and implement custom logic\n * - Use `onItemsChange` callback to react to items being added or removed from the queue\n * - Use `onExpire` callback to react to items expiring and implement custom logic\n * - Use `onReject` callback to react to items being rejected when the queue is full\n * - The state includes execution count, expiration count, rejection count, and isRunning status\n * - State can be accessed via `queuer.store.state` when using the class directly\n * - When using framework adapters (React/Solid), state is accessed from `queuer.state`\n *\n * Example usage:\n * ```ts\n * // Auto-processing queue with wait time\n * const autoQueue = new Queuer<number>((n) => console.log(n), {\n * started: true, // Begin processing immediately\n * wait: 1000, // Wait 1s between items\n * onExecute: (item, queuer) => console.log(`Processed ${item}`)\n * });\n * autoQueue.addItem(1); // Will process after 1s\n * autoQueue.addItem(2); // Will process 1s after first item\n *\n * // Manual processing queue\n * const manualQueue = new Queuer<number>((n) => console.log(n), {\n * started: false\n * });\n * manualQueue.addItem(1); // [1]\n * manualQueue.addItem(2); // [1, 2]\n * manualQueue.execute(); // logs 1, queue is [2]\n * manualQueue.getNextItem(); // returns 2, queue is empty\n * ```\n */\nexport class Queuer<TValue> {\n readonly store: Store<Readonly<QueuerState<TValue>>> = new Store(\n getDefaultQueuerState<TValue>(),\n )\n key: string | undefined\n options: QueuerOptions<TValue>\n #timeoutId: ReturnType<typeof setTimeout> | null = null\n\n constructor(\n public fn: (item: TValue) => void,\n initialOptions: QueuerOptions<TValue> = {},\n ) {\n this.key = initialOptions.key\n this.options = {\n ...defaultOptions,\n ...initialOptions,\n }\n const isInitiallyRunning =\n this.options.initialState?.isRunning ?? this.options.started ?? true\n this.#setState({\n ...this.options.initialState,\n isRunning: isInitiallyRunning,\n })\n\n if (this.options.initialState?.items) {\n if (this.store.state.isRunning) {\n this.#tick()\n }\n } else {\n for (let i = 0; i < (this.options.initialItems?.length ?? 0); i++) {\n const item = this.options.initialItems![i]!\n const isLast = i === (this.options.initialItems?.length ?? 0) - 1\n this.addItem(item, this.options.addItemsTo ?? 'back', isLast)\n }\n }\n\n if (this.key) {\n pacerEventClient.on('d-Queuer', (event) => {\n if (event.payload.key !== this.key) return\n this.#setState(\n event.payload.store.state as Partial<QueuerState<TValue>>,\n )\n this.setOptions(event.payload.options as Partial<QueuerOptions<TValue>>)\n })\n }\n }\n\n /**\n * Updates the queuer options. New options are merged with existing options.\n */\n setOptions = (newOptions: Partial<QueuerOptions<TValue>>): void => {\n this.options = { ...this.options, ...newOptions }\n }\n\n #setState = (newState: Partial<QueuerState<TValue>>): void => {\n this.store.setState((state) => {\n const combinedState = {\n ...state,\n ...newState,\n }\n\n const { items, isRunning } = combinedState\n\n const size = items.length\n const isFull = size >= (this.options.maxSize ?? Infinity)\n const isEmpty = size === 0\n const isIdle = isRunning && isEmpty\n\n const status = isIdle ? 'idle' : isRunning ? 'running' : 'stopped'\n\n return {\n ...combinedState,\n isEmpty,\n isFull,\n isIdle,\n size,\n status,\n }\n })\n emitChange('Queuer', this)\n }\n\n /**\n * Returns the current wait time (in milliseconds) between processing items.\n * If a function is provided, it is called with the queuer instance.\n */\n #getWait = (): number => {\n return parseFunctionOrValue(this.options.wait ?? 0, this)\n }\n\n /**\n * Processes items in the queue up to the wait interval. Internal use only.\n */\n #tick = () => {\n if (!this.store.state.isRunning) {\n this.#setState({ pendingTick: false })\n return\n }\n\n this.#setState({ pendingTick: true })\n\n // Check for expired items\n this.#checkExpiredItems()\n\n while (this.store.state.items.length > 0) {\n const nextItem = this.execute(this.options.getItemsFrom ?? 'front')\n if (nextItem === undefined) {\n break\n }\n\n const wait = this.#getWait()\n if (wait > 0) {\n // Use setTimeout to wait before processing next item\n this.#timeoutId = setTimeout(() => this.#tick(), wait)\n return\n }\n\n this.#tick()\n }\n this.#setState({ pendingTick: false })\n }\n\n /**\n * Adds an item to the queue. If the queue is full, the item is rejected and onReject is called.\n * `undefined` cannot be queued (it is the internal \"no item\" sentinel) and is always rejected.\n * Items can be inserted based on priority or at the front/back depending on configuration.\n *\n * Returns true if the item was added, false if the queue is full.\n *\n * Example usage:\n * ```ts\n * queuer.addItem('task');\n * queuer.addItem('task2', 'front');\n * ```\n */\n addItem = (\n item: TValue,\n position: QueuePosition = this.options.addItemsTo ?? 'back',\n runOnItemsChange: boolean = true,\n ): boolean => {\n this.#setState({\n addItemCount: this.store.state.addItemCount + 1,\n })\n\n // undefined is the internal \"no item\" sentinel (peekNextItem/getNextItem);\n // queuing it would break the processing loop and block items behind it\n if (item === undefined) {\n this.#setState({\n rejectionCount: this.store.state.rejectionCount + 1,\n })\n this.options.onReject?.(item, this)\n return false\n }\n\n if (this.store.state.items.length >= (this.options.maxSize ?? Infinity)) {\n this.#setState({\n rejectionCount: this.store.state.rejectionCount + 1,\n })\n this.options.onReject?.(item, this)\n return false\n }\n\n // Get priority either from the function or from getPriority option\n const priority =\n this.options.getPriority !== defaultOptions.getPriority\n ? this.options.getPriority!(item)\n : (item as any)?.priority\n\n const items = this.store.state.items\n const itemTimestamps = this.store.state.itemTimestamps\n\n if (priority !== undefined) {\n // Insert based on priority - higher priority items go to front\n const insertIndex = items.findIndex((existing) => {\n const existingPriority: number =\n this.options.getPriority !== defaultOptions.getPriority\n ? this.options.getPriority!(existing)\n : (existing as any)?.priority\n return existingPriority < priority\n })\n\n if (insertIndex === -1) {\n items.push(item)\n itemTimestamps.push(Date.now())\n } else {\n items.splice(insertIndex, 0, item)\n itemTimestamps.splice(insertIndex, 0, Date.now())\n }\n } else {\n if (position === 'front') {\n // Default FIFO/LIFO behavior\n items.unshift(item)\n itemTimestamps.unshift(Date.now())\n } else {\n // LIFO\n items.push(item)\n itemTimestamps.push(Date.now())\n }\n }\n\n this.#setState({\n items,\n itemTimestamps,\n })\n\n if (runOnItemsChange) {\n this.options.onItemsChange?.(this)\n }\n\n if (this.store.state.isRunning && !this.store.state.pendingTick) {\n this.#setState({ pendingTick: true })\n this.#tick()\n }\n\n return true\n }\n\n /**\n * Removes and returns the next item from the queue without executing the function.\n * Use for manual queue management. Normally, use execute() to process items.\n *\n * Example usage:\n * ```ts\n * // FIFO\n * queuer.getNextItem();\n * // LIFO\n * queuer.getNextItem('back');\n * ```\n */\n getNextItem = (\n position: QueuePosition = this.options.getItemsFrom ?? 'front',\n ): TValue | undefined => {\n const { items, itemTimestamps } = this.store.state\n let item: TValue | undefined\n\n // When priority function is provided, always get from front (highest priority)\n // Priority takes precedence over FIFO/LIFO behavior\n if (\n this.options.getPriority !== defaultOptions.getPriority ||\n position === 'front'\n ) {\n item = items[0]\n if (item !== undefined) {\n this.#setState({\n items: items.slice(1),\n itemTimestamps: itemTimestamps.slice(1),\n })\n }\n } else {\n item = items[items.length - 1]\n if (item !== undefined) {\n this.#setState({\n items: items.slice(0, -1),\n itemTimestamps: itemTimestamps.slice(0, -1),\n })\n }\n }\n\n if (item !== undefined) {\n this.options.onItemsChange?.(this)\n }\n\n return item\n }\n\n #getAllItems = (): Array<TValue> => {\n const items = this.peekAllItems()\n this.clear()\n return items\n }\n\n /**\n * Removes and returns the next item from the queue and processes it using the provided function.\n *\n * Example usage:\n * ```ts\n * queuer.execute();\n * // LIFO\n * queuer.execute('back');\n * ```\n */\n execute = (position?: QueuePosition): TValue | undefined => {\n const item = this.getNextItem(position)\n if (item !== undefined) {\n this.fn(item)\n this.#setState({\n executionCount: this.store.state.executionCount + 1,\n })\n this.options.onExecute?.(item, this)\n }\n return item\n }\n\n /**\n * Processes a specified number of items to execute immediately with no wait time\n * If no numberOfItems is provided, all items will be processed\n */\n flush = (\n numberOfItems: number = this.store.state.items.length,\n position?: QueuePosition,\n ): void => {\n this.#clearTimeout() // clear any pending timeout\n for (let i = 0; i < numberOfItems; i++) {\n this.execute(position)\n }\n this.#tick()\n }\n\n /**\n * Processes all items in the queue as a batch using the provided function as an argument\n * The queue is cleared after processing\n */\n flushAsBatch = (batchFunction: (items: Array<TValue>) => void): void => {\n const items = this.#getAllItems()\n this.clear()\n batchFunction(items)\n }\n\n /**\n * Checks for expired items in the queue and removes them. Calls onExpire for each expired item.\n * Internal use only.\n */\n #checkExpiredItems = (): void => {\n if (\n (this.options.expirationDuration ?? Infinity) === Infinity &&\n this.options.getIsExpired === defaultOptions.getIsExpired\n ) {\n return\n }\n\n const now = Date.now()\n const expiredIndices: Array<number> = []\n\n // Find indices of expired items\n for (let i = 0; i < this.store.state.items.length; i++) {\n const timestamp = this.store.state.itemTimestamps[i]\n if (timestamp === undefined) continue\n\n const item = this.store.state.items[i]\n if (item === undefined) continue\n\n const isExpired =\n this.options.getIsExpired !== defaultOptions.getIsExpired\n ? this.options.getIsExpired!(item, timestamp)\n : now - timestamp > (this.options.expirationDuration ?? Infinity)\n\n if (isExpired) {\n expiredIndices.push(i)\n }\n }\n\n // Remove expired items from back to front to maintain indices\n for (let i = expiredIndices.length - 1; i >= 0; i--) {\n const index = expiredIndices[i]\n if (index === undefined) continue\n\n const expiredItem = this.store.state.items[index]\n if (expiredItem === undefined) continue\n\n const newItems = [...this.store.state.items]\n const newTimestamps = [...this.store.state.itemTimestamps]\n newItems.splice(index, 1)\n newTimestamps.splice(index, 1)\n this.#setState({\n items: newItems,\n itemTimestamps: newTimestamps,\n expirationCount: this.store.state.expirationCount + 1,\n })\n this.options.onExpire?.(expiredItem, this)\n }\n\n if (expiredIndices.length > 0) {\n this.options.onItemsChange?.(this)\n }\n }\n\n /**\n * Returns the next item in the queue without removing it.\n *\n * Example usage:\n * ```ts\n * queuer.peekNextItem(); // front\n * queuer.peekNextItem('back'); // back\n * ```\n */\n peekNextItem = (position: QueuePosition = 'front'): TValue | undefined => {\n if (position === 'front') {\n return this.store.state.items[0]\n }\n return this.store.state.items[this.store.state.items.length - 1]\n }\n\n /**\n * Returns a copy of all items in the queue.\n */\n peekAllItems = (): Array<TValue> => {\n return [...this.store.state.items]\n }\n\n /**\n * Starts processing items in the queue. If already isRunning, does nothing.\n */\n start = () => {\n this.#setState({ isRunning: true })\n if (!this.store.state.pendingTick && this.store.state.items.length > 0) {\n this.#tick()\n }\n }\n\n /**\n * Stops processing items in the queue. Does not clear the queue.\n */\n stop = () => {\n this.#clearTimeout()\n this.#setState({ isRunning: false, pendingTick: false })\n }\n\n #clearTimeout = (): void => {\n if (this.#timeoutId) {\n clearTimeout(this.#timeoutId)\n this.#timeoutId = null\n }\n }\n\n /**\n * Removes all pending items from the queue. Does not affect items being processed.\n */\n clear = (): void => {\n this.#setState({ items: [], itemTimestamps: [] })\n this.options.onItemsChange?.(this)\n }\n\n /**\n * Resets the queuer state to its default values\n */\n reset = (): void => {\n this.#setState(getDefaultQueuerState<TValue>())\n this.options.onItemsChange?.(this)\n }\n}\n\n/**\n * Creates a queue that processes items immediately upon addition.\n * Items are processed sequentially in FIFO order by default.\n *\n * This synchronous version is lighter weight and often all you need - upgrade to asyncQueue when you need promises, retry support, abort capabilities, concurrent execution, or advanced error handling.\n *\n * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the queuer\n * - Use `onExecute` callback to react to item execution and implement custom logic\n * - Use `onItemsChange` callback to react to items being added or removed from the queue\n * - Use `onExpire` callback to react to items expiring and implement custom logic\n * - Use `onReject` callback to react to items being rejected when the queue is full\n * - The state includes execution count, expiration count, rejection count, and isRunning status\n * - State can be accessed via the underlying Queuer instance's `store.state` property\n * - When using framework adapters (React/Solid), state is accessed from the hook's state property\n *\n * Example usage:\n * ```ts\n * // Basic sequential processing\n * const processItems = queue<number>((n) => console.log(n), {\n * wait: 1000,\n * onItemsChange: (queuer) => console.log(queuer.peekAllItems())\n * });\n * processItems(1); // Logs: 1\n * processItems(2); // Logs: 2 after 1 completes\n *\n * // Priority queue\n * const processPriority = queue<number>((n) => console.log(n), {\n * getPriority: n => n // Higher numbers processed first\n * });\n * processPriority(1);\n * processPriority(3); // Processed before 1\n * ```\n */\nexport function queue<TValue>(\n fn: (item: TValue) => void,\n initialOptions: QueuerOptions<TValue>,\n) {\n const queuer = new Queuer<TValue>(fn, initialOptions)\n return queuer.addItem\n}\n"],"mappings":";;;;;;AA2DA,SAAS,wBAAqD;CAC5D,OAAO;EACL,gBAAgB;EAChB,iBAAiB;EACjB,SAAS;EACT,QAAQ;EACR,QAAQ;EACR,WAAW;EACX,gBAAgB,CAAC;EACjB,OAAO,CAAC;EACR,aAAa;EACb,gBAAgB;EAChB,MAAM;EACN,QAAQ;EACR,cAAc;CAChB;AACF;;;;AAiFA,SAAgB,cAKd,SAA6B;CAC7B,OAAO;AACT;AAEA,MAAM,iBASF;CACF,YAAY;CACZ,cAAc;CACd,cAAc,SAAS,MAAM,YAAY;CACzC,oBAAoB;CACpB,oBAAoB;CACpB,cAAc,CAAC;CACf,SAAS;CACT,SAAS;CACT,MAAM;AACR;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoFA,IAAa,SAAb,MAA4B;CAM1B;CAEA,YACE,AAAO,IACP,iBAAwC,CAAC,GACzC;EAFO;eAR8C,IAAIA,sBACzD,sBAA8B,CAChC;oBAGmD;qBA4CrC,eAAqD;GACjE,KAAK,UAAU;IAAE,GAAG,KAAK;IAAS,GAAG;GAAW;EAClD;oBAEa,aAAiD;GAC5D,KAAK,MAAM,UAAU,UAAU;IAC7B,MAAM,gBAAgB;KACpB,GAAG;KACH,GAAG;IACL;IAEA,MAAM,EAAE,OAAO,cAAc;IAE7B,MAAM,OAAO,MAAM;IACnB,MAAM,SAAS,SAAS,KAAK,QAAQ,WAAW;IAChD,MAAM,UAAU,SAAS;IACzB,MAAM,SAAS,aAAa;IAE5B,MAAM,SAAS,SAAS,SAAS,YAAY,YAAY;IAEzD,OAAO;KACL,GAAG;KACH;KACA;KACA;KACA;KACA;IACF;GACF,CAAC;GACD,gCAAW,UAAU,IAAI;EAC3B;wBAMyB;GACvB,OAAOC,mCAAqB,KAAK,QAAQ,QAAQ,GAAG,IAAI;EAC1D;qBAKc;GACZ,IAAI,CAAC,KAAK,MAAM,MAAM,WAAW;IAC/B,KAAKC,UAAU,EAAE,aAAa,MAAM,CAAC;IACrC;GACF;GAEA,KAAKA,UAAU,EAAE,aAAa,KAAK,CAAC;GAGpC,KAAKC,mBAAmB;GAExB,OAAO,KAAK,MAAM,MAAM,MAAM,SAAS,GAAG;IAExC,IADiB,KAAK,QAAQ,KAAK,QAAQ,gBAAgB,OAChD,MAAM,QACf;IAGF,MAAM,OAAO,KAAKC,SAAS;IAC3B,IAAI,OAAO,GAAG;KAEZ,KAAKC,aAAa,iBAAiB,KAAKC,MAAM,GAAG,IAAI;KACrD;IACF;IAEA,KAAKA,MAAM;GACb;GACA,KAAKJ,UAAU,EAAE,aAAa,MAAM,CAAC;EACvC;kBAgBE,MACA,WAA0B,KAAK,QAAQ,cAAc,QACrD,mBAA4B,SAChB;GACZ,KAAKA,UAAU,EACb,cAAc,KAAK,MAAM,MAAM,eAAe,EAChD,CAAC;GAID,IAAI,SAAS,QAAW;IACtB,KAAKA,UAAU,EACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB,EACpD,CAAC;IACD,KAAK,QAAQ,WAAW,MAAM,IAAI;IAClC,OAAO;GACT;GAEA,IAAI,KAAK,MAAM,MAAM,MAAM,WAAW,KAAK,QAAQ,WAAW,WAAW;IACvE,KAAKA,UAAU,EACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB,EACpD,CAAC;IACD,KAAK,QAAQ,WAAW,MAAM,IAAI;IAClC,OAAO;GACT;GAGA,MAAM,WACJ,KAAK,QAAQ,gBAAgB,eAAe,cACxC,KAAK,QAAQ,YAAa,IAAI,IAC7B,MAAc;GAErB,MAAM,QAAQ,KAAK,MAAM,MAAM;GAC/B,MAAM,iBAAiB,KAAK,MAAM,MAAM;GAExC,IAAI,aAAa,QAAW;IAE1B,MAAM,cAAc,MAAM,WAAW,aAAa;KAKhD,QAHE,KAAK,QAAQ,gBAAgB,eAAe,cACxC,KAAK,QAAQ,YAAa,QAAQ,IACjC,UAAkB,YACC;IAC5B,CAAC;IAED,IAAI,gBAAgB,IAAI;KACtB,MAAM,KAAK,IAAI;KACf,eAAe,KAAK,KAAK,IAAI,CAAC;IAChC,OAAO;KACL,MAAM,OAAO,aAAa,GAAG,IAAI;KACjC,eAAe,OAAO,aAAa,GAAG,KAAK,IAAI,CAAC;IAClD;GACF,OACE,IAAI,aAAa,SAAS;IAExB,MAAM,QAAQ,IAAI;IAClB,eAAe,QAAQ,KAAK,IAAI,CAAC;GACnC,OAAO;IAEL,MAAM,KAAK,IAAI;IACf,eAAe,KAAK,KAAK,IAAI,CAAC;GAChC;GAGF,KAAKA,UAAU;IACb;IACA;GACF,CAAC;GAED,IAAI,kBACF,KAAK,QAAQ,gBAAgB,IAAI;GAGnC,IAAI,KAAK,MAAM,MAAM,aAAa,CAAC,KAAK,MAAM,MAAM,aAAa;IAC/D,KAAKA,UAAU,EAAE,aAAa,KAAK,CAAC;IACpC,KAAKI,MAAM;GACb;GAEA,OAAO;EACT;sBAeE,WAA0B,KAAK,QAAQ,gBAAgB,YAChC;GACvB,MAAM,EAAE,OAAO,mBAAmB,KAAK,MAAM;GAC7C,IAAI;GAIJ,IACE,KAAK,QAAQ,gBAAgB,eAAe,eAC5C,aAAa,SACb;IACA,OAAO,MAAM;IACb,IAAI,SAAS,QACX,KAAKJ,UAAU;KACb,OAAO,MAAM,MAAM,CAAC;KACpB,gBAAgB,eAAe,MAAM,CAAC;IACxC,CAAC;GAEL,OAAO;IACL,OAAO,MAAM,MAAM,SAAS;IAC5B,IAAI,SAAS,QACX,KAAKA,UAAU;KACb,OAAO,MAAM,MAAM,GAAG,EAAE;KACxB,gBAAgB,eAAe,MAAM,GAAG,EAAE;IAC5C,CAAC;GAEL;GAEA,IAAI,SAAS,QACX,KAAK,QAAQ,gBAAgB,IAAI;GAGnC,OAAO;EACT;4BAEoC;GAClC,MAAM,QAAQ,KAAK,aAAa;GAChC,KAAK,MAAM;GACX,OAAO;EACT;kBAYW,aAAiD;GAC1D,MAAM,OAAO,KAAK,YAAY,QAAQ;GACtC,IAAI,SAAS,QAAW;IACtB,KAAK,GAAG,IAAI;IACZ,KAAKA,UAAU,EACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB,EACpD,CAAC;IACD,KAAK,QAAQ,YAAY,MAAM,IAAI;GACrC;GACA,OAAO;EACT;gBAOE,gBAAwB,KAAK,MAAM,MAAM,MAAM,QAC/C,aACS;GACT,KAAKK,cAAc;GACnB,KAAK,IAAI,IAAI,GAAG,IAAI,eAAe,KACjC,KAAK,QAAQ,QAAQ;GAEvB,KAAKD,MAAM;EACb;uBAMgB,kBAAwD;GACtE,MAAM,QAAQ,KAAKE,aAAa;GAChC,KAAK,MAAM;GACX,cAAc,KAAK;EACrB;kCAMiC;GAC/B,KACG,KAAK,QAAQ,sBAAsB,cAAc,YAClD,KAAK,QAAQ,iBAAiB,eAAe,cAE7C;GAGF,MAAM,MAAM,KAAK,IAAI;GACrB,MAAM,iBAAgC,CAAC;GAGvC,KAAK,IAAI,IAAI,GAAG,IAAI,KAAK,MAAM,MAAM,MAAM,QAAQ,KAAK;IACtD,MAAM,YAAY,KAAK,MAAM,MAAM,eAAe;IAClD,IAAI,cAAc,QAAW;IAE7B,MAAM,OAAO,KAAK,MAAM,MAAM,MAAM;IACpC,IAAI,SAAS,QAAW;IAOxB,IAJE,KAAK,QAAQ,iBAAiB,eAAe,eACzC,KAAK,QAAQ,aAAc,MAAM,SAAS,IAC1C,MAAM,aAAa,KAAK,QAAQ,sBAAsB,WAG1D,eAAe,KAAK,CAAC;GAEzB;GAGA,KAAK,IAAI,IAAI,eAAe,SAAS,GAAG,KAAK,GAAG,KAAK;IACnD,MAAM,QAAQ,eAAe;IAC7B,IAAI,UAAU,QAAW;IAEzB,MAAM,cAAc,KAAK,MAAM,MAAM,MAAM;IAC3C,IAAI,gBAAgB,QAAW;IAE/B,MAAM,WAAW,CAAC,GAAG,KAAK,MAAM,MAAM,KAAK;IAC3C,MAAM,gBAAgB,CAAC,GAAG,KAAK,MAAM,MAAM,cAAc;IACzD,SAAS,OAAO,OAAO,CAAC;IACxB,cAAc,OAAO,OAAO,CAAC;IAC7B,KAAKN,UAAU;KACb,OAAO;KACP,gBAAgB;KAChB,iBAAiB,KAAK,MAAM,MAAM,kBAAkB;IACtD,CAAC;IACD,KAAK,QAAQ,WAAW,aAAa,IAAI;GAC3C;GAEA,IAAI,eAAe,SAAS,GAC1B,KAAK,QAAQ,gBAAgB,IAAI;EAErC;uBAWgB,WAA0B,YAAgC;GACxE,IAAI,aAAa,SACf,OAAO,KAAK,MAAM,MAAM,MAAM;GAEhC,OAAO,KAAK,MAAM,MAAM,MAAM,KAAK,MAAM,MAAM,MAAM,SAAS;EAChE;4BAKoC;GAClC,OAAO,CAAC,GAAG,KAAK,MAAM,MAAM,KAAK;EACnC;qBAKc;GACZ,KAAKA,UAAU,EAAE,WAAW,KAAK,CAAC;GAClC,IAAI,CAAC,KAAK,MAAM,MAAM,eAAe,KAAK,MAAM,MAAM,MAAM,SAAS,GACnE,KAAKI,MAAM;EAEf;oBAKa;GACX,KAAKC,cAAc;GACnB,KAAKL,UAAU;IAAE,WAAW;IAAO,aAAa;GAAM,CAAC;EACzD;6BAE4B;GAC1B,IAAI,KAAKG,YAAY;IACnB,aAAa,KAAKA,UAAU;IAC5B,KAAKA,aAAa;GACpB;EACF;qBAKoB;GAClB,KAAKH,UAAU;IAAE,OAAO,CAAC;IAAG,gBAAgB,CAAC;GAAE,CAAC;GAChD,KAAK,QAAQ,gBAAgB,IAAI;EACnC;qBAKoB;GAClB,KAAKA,UAAU,sBAA8B,CAAC;GAC9C,KAAK,QAAQ,gBAAgB,IAAI;EACnC;EA1aE,KAAK,MAAM,eAAe;EAC1B,KAAK,UAAU;GACb,GAAG;GACH,GAAG;EACL;EACA,MAAM,qBACJ,KAAK,QAAQ,cAAc,aAAa,KAAK,QAAQ,WAAW;EAClE,KAAKA,UAAU;GACb,GAAG,KAAK,QAAQ;GAChB,WAAW;EACb,CAAC;EAED,IAAI,KAAK,QAAQ,cAAc,OAC7B;OAAI,KAAK,MAAM,MAAM,WACnB,KAAKI,MAAM;EACb,OAEA,KAAK,IAAI,IAAI,GAAG,KAAK,KAAK,QAAQ,cAAc,UAAU,IAAI,KAAK;GACjE,MAAM,OAAO,KAAK,QAAQ,aAAc;GACxC,MAAM,SAAS,OAAO,KAAK,QAAQ,cAAc,UAAU,KAAK;GAChE,KAAK,QAAQ,MAAM,KAAK,QAAQ,cAAc,QAAQ,MAAM;EAC9D;EAGF,IAAI,KAAK,KACP,sCAAiB,GAAG,aAAa,UAAU;GACzC,IAAI,MAAM,QAAQ,QAAQ,KAAK,KAAK;GACpC,KAAKJ,UACH,MAAM,QAAQ,MAAM,KACtB;GACA,KAAK,WAAW,MAAM,QAAQ,OAAyC;EACzE,CAAC;CAEL;CASA;;;;;CAgCA;;;;CAOA;CA4KA;;;;;CAyDA;CA+FA;AAsBF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCA,SAAgB,MACd,IACA,gBACA;CAEA,OAAO,IADY,OAAe,IAAI,cAC1B,CAAC,CAAC;AAChB"}
|
package/dist/queuer.d.cts
DELETED
|
@@ -1,345 +0,0 @@
|
|
|
1
|
-
import { Store } from "@tanstack/store";
|
|
2
|
-
//#region src/queuer.d.ts
|
|
3
|
-
interface QueuerState<TValue> {
|
|
4
|
-
/**
|
|
5
|
-
* Number of times addItem has been called (for reduction calculations)
|
|
6
|
-
*/
|
|
7
|
-
addItemCount: number;
|
|
8
|
-
/**
|
|
9
|
-
* Number of items that have been processed by the queuer
|
|
10
|
-
*/
|
|
11
|
-
executionCount: number;
|
|
12
|
-
/**
|
|
13
|
-
* Number of items that have been removed from the queue due to expiration
|
|
14
|
-
*/
|
|
15
|
-
expirationCount: number;
|
|
16
|
-
/**
|
|
17
|
-
* Whether the queuer has no items to process (items array is empty)
|
|
18
|
-
*/
|
|
19
|
-
isEmpty: boolean;
|
|
20
|
-
/**
|
|
21
|
-
* Whether the queuer has reached its maximum capacity
|
|
22
|
-
*/
|
|
23
|
-
isFull: boolean;
|
|
24
|
-
/**
|
|
25
|
-
* Whether the queuer is not currently processing any items
|
|
26
|
-
*/
|
|
27
|
-
isIdle: boolean;
|
|
28
|
-
/**
|
|
29
|
-
* Whether the queuer is active and will process items automatically
|
|
30
|
-
*/
|
|
31
|
-
isRunning: boolean;
|
|
32
|
-
/**
|
|
33
|
-
* Array of items currently waiting to be processed
|
|
34
|
-
*/
|
|
35
|
-
items: Array<TValue>;
|
|
36
|
-
/**
|
|
37
|
-
* Timestamps when items were added to the queue for expiration tracking
|
|
38
|
-
*/
|
|
39
|
-
itemTimestamps: Array<number>;
|
|
40
|
-
/**
|
|
41
|
-
* Whether the queuer has a pending timeout for processing the next item
|
|
42
|
-
*/
|
|
43
|
-
pendingTick: boolean;
|
|
44
|
-
/**
|
|
45
|
-
* Number of items that have been rejected from being added to the queue
|
|
46
|
-
*/
|
|
47
|
-
rejectionCount: number;
|
|
48
|
-
/**
|
|
49
|
-
* Number of items currently in the queue
|
|
50
|
-
*/
|
|
51
|
-
size: number;
|
|
52
|
-
/**
|
|
53
|
-
* Current processing status - 'idle' when not processing, 'running' when active, 'stopped' when paused
|
|
54
|
-
*/
|
|
55
|
-
status: 'idle' | 'running' | 'stopped';
|
|
56
|
-
}
|
|
57
|
-
/**
|
|
58
|
-
* Options for configuring a Queuer instance.
|
|
59
|
-
*
|
|
60
|
-
* These options control queue behavior, item expiration, callbacks, and more.
|
|
61
|
-
*/
|
|
62
|
-
interface QueuerOptions<TValue> {
|
|
63
|
-
/**
|
|
64
|
-
* Default position to add items to the queuer
|
|
65
|
-
* @default 'back'
|
|
66
|
-
*/
|
|
67
|
-
addItemsTo?: QueuePosition;
|
|
68
|
-
/**
|
|
69
|
-
* Maximum time in milliseconds that an item can stay in the queue
|
|
70
|
-
* If not provided, items will never expire
|
|
71
|
-
*/
|
|
72
|
-
expirationDuration?: number;
|
|
73
|
-
/**
|
|
74
|
-
* Function to determine if an item has expired
|
|
75
|
-
* If provided, this overrides the expirationDuration behavior
|
|
76
|
-
*/
|
|
77
|
-
getIsExpired?: (item: TValue, addedAt: number) => boolean;
|
|
78
|
-
/**
|
|
79
|
-
* Default position to get items from during processing
|
|
80
|
-
* @default 'front'
|
|
81
|
-
*/
|
|
82
|
-
getItemsFrom?: QueuePosition;
|
|
83
|
-
/**
|
|
84
|
-
* Function to determine priority of items in the queuer
|
|
85
|
-
* Higher priority items will be processed first
|
|
86
|
-
*/
|
|
87
|
-
getPriority?: (item: TValue) => number;
|
|
88
|
-
/**
|
|
89
|
-
* Initial items to populate the queuer with
|
|
90
|
-
*/
|
|
91
|
-
initialItems?: Array<TValue>;
|
|
92
|
-
/**
|
|
93
|
-
* Initial state for the queuer
|
|
94
|
-
*/
|
|
95
|
-
initialState?: Partial<QueuerState<TValue>>;
|
|
96
|
-
/**
|
|
97
|
-
* Optional key to identify this queuer instance.
|
|
98
|
-
* If provided, the queuer will be identified by this key in the devtools and PacerProvider if applicable.
|
|
99
|
-
*/
|
|
100
|
-
key?: string;
|
|
101
|
-
/**
|
|
102
|
-
* Maximum number of items allowed in the queuer
|
|
103
|
-
*/
|
|
104
|
-
maxSize?: number;
|
|
105
|
-
/**
|
|
106
|
-
* Callback fired whenever an item is removed from the queuer
|
|
107
|
-
*/
|
|
108
|
-
onExecute?: (item: TValue, queuer: Queuer<TValue>) => void;
|
|
109
|
-
/**
|
|
110
|
-
* Callback fired whenever an item expires in the queuer
|
|
111
|
-
*/
|
|
112
|
-
onExpire?: (item: TValue, queuer: Queuer<TValue>) => void;
|
|
113
|
-
/**
|
|
114
|
-
* Callback fired whenever an item is added or removed from the queuer
|
|
115
|
-
*/
|
|
116
|
-
onItemsChange?: (queuer: Queuer<TValue>) => void;
|
|
117
|
-
/**
|
|
118
|
-
* Callback fired whenever an item is rejected from being added to the queuer
|
|
119
|
-
*/
|
|
120
|
-
onReject?: (item: TValue, queuer: Queuer<TValue>) => void;
|
|
121
|
-
/**
|
|
122
|
-
* Whether the queuer should start processing tasks immediately
|
|
123
|
-
*/
|
|
124
|
-
started?: boolean;
|
|
125
|
-
/**
|
|
126
|
-
* Time in milliseconds to wait between processing items.
|
|
127
|
-
* Can be a number or a function that returns a number.
|
|
128
|
-
* @default 0
|
|
129
|
-
*/
|
|
130
|
-
wait?: number | ((queuer: Queuer<TValue>) => number);
|
|
131
|
-
}
|
|
132
|
-
/**
|
|
133
|
-
* Utility function for sharing common `QueuerOptions` options between different `Queuer` instances.
|
|
134
|
-
*/
|
|
135
|
-
declare function queuerOptions<TValue = any, TOptions extends Partial<QueuerOptions<TValue>> = Partial<QueuerOptions<TValue>>>(options: TOptions): TOptions;
|
|
136
|
-
/**
|
|
137
|
-
* Position type for addItem and getNextItem operations.
|
|
138
|
-
*
|
|
139
|
-
* - 'front': Operate on the front of the queue (FIFO)
|
|
140
|
-
* - 'back': Operate on the back of the queue (LIFO)
|
|
141
|
-
*/
|
|
142
|
-
type QueuePosition = 'front' | 'back';
|
|
143
|
-
/**
|
|
144
|
-
* A flexible queue that processes items with configurable wait times, expiration, and priority.
|
|
145
|
-
*
|
|
146
|
-
* This synchronous version is lighter weight and often all you need - upgrade to AsyncQueuer when you need promises, retry support, abort capabilities, concurrent execution, or advanced error handling.
|
|
147
|
-
*
|
|
148
|
-
* Features:
|
|
149
|
-
* - Automatic or manual processing of items
|
|
150
|
-
* - FIFO (First In First Out), LIFO (Last In First Out), or double-ended queue behavior
|
|
151
|
-
* - Priority-based ordering when getPriority is provided
|
|
152
|
-
* - Item expiration and removal of stale items
|
|
153
|
-
* - Callbacks for queue state changes, execution, rejection, and expiration
|
|
154
|
-
*
|
|
155
|
-
* Running behavior:
|
|
156
|
-
* - `start()`: Begins automatically processing items in the queue (defaults to isRunning)
|
|
157
|
-
* - `stop()`: Pauses processing but maintains queue state
|
|
158
|
-
* - `wait`: Configurable delay between processing items
|
|
159
|
-
* - `onItemsChange`/`onExecute`: Callbacks for monitoring queue state
|
|
160
|
-
*
|
|
161
|
-
* Manual processing is also supported when automatic processing is disabled:
|
|
162
|
-
* - `execute()`: Processes the next item using the provided function
|
|
163
|
-
* - `getNextItem()`: Removes and returns the next item without processing
|
|
164
|
-
*
|
|
165
|
-
* Queue behavior defaults to FIFO:
|
|
166
|
-
* - `addItem(item)`: Adds to the back of the queue
|
|
167
|
-
* - Items processed from the front of the queue
|
|
168
|
-
*
|
|
169
|
-
* Priority queue:
|
|
170
|
-
* - Provide a `getPriority` function; higher values are processed first
|
|
171
|
-
*
|
|
172
|
-
* Stack (LIFO):
|
|
173
|
-
* - `addItem(item, 'back')`: Adds to the back
|
|
174
|
-
* - `getNextItem('back')`: Removes from the back
|
|
175
|
-
*
|
|
176
|
-
* Double-ended queue:
|
|
177
|
-
* - `addItem(item, position)`: Adds to specified position ('front'/'back')
|
|
178
|
-
* - `getNextItem(position)`: Removes from specified position
|
|
179
|
-
*
|
|
180
|
-
* Item expiration:
|
|
181
|
-
* - `expirationDuration`: Maximum time items can stay in the queue
|
|
182
|
-
* - `getIsExpired`: Function to override default expiration
|
|
183
|
-
* - `onExpire`: Callback for expired items
|
|
184
|
-
*
|
|
185
|
-
* State Management:
|
|
186
|
-
* - Uses TanStack Store for reactive state management
|
|
187
|
-
* - Use `initialState` to provide initial state values when creating the queuer
|
|
188
|
-
* - Use `onExecute` callback to react to item execution and implement custom logic
|
|
189
|
-
* - Use `onItemsChange` callback to react to items being added or removed from the queue
|
|
190
|
-
* - Use `onExpire` callback to react to items expiring and implement custom logic
|
|
191
|
-
* - Use `onReject` callback to react to items being rejected when the queue is full
|
|
192
|
-
* - The state includes execution count, expiration count, rejection count, and isRunning status
|
|
193
|
-
* - State can be accessed via `queuer.store.state` when using the class directly
|
|
194
|
-
* - When using framework adapters (React/Solid), state is accessed from `queuer.state`
|
|
195
|
-
*
|
|
196
|
-
* Example usage:
|
|
197
|
-
* ```ts
|
|
198
|
-
* // Auto-processing queue with wait time
|
|
199
|
-
* const autoQueue = new Queuer<number>((n) => console.log(n), {
|
|
200
|
-
* started: true, // Begin processing immediately
|
|
201
|
-
* wait: 1000, // Wait 1s between items
|
|
202
|
-
* onExecute: (item, queuer) => console.log(`Processed ${item}`)
|
|
203
|
-
* });
|
|
204
|
-
* autoQueue.addItem(1); // Will process after 1s
|
|
205
|
-
* autoQueue.addItem(2); // Will process 1s after first item
|
|
206
|
-
*
|
|
207
|
-
* // Manual processing queue
|
|
208
|
-
* const manualQueue = new Queuer<number>((n) => console.log(n), {
|
|
209
|
-
* started: false
|
|
210
|
-
* });
|
|
211
|
-
* manualQueue.addItem(1); // [1]
|
|
212
|
-
* manualQueue.addItem(2); // [1, 2]
|
|
213
|
-
* manualQueue.execute(); // logs 1, queue is [2]
|
|
214
|
-
* manualQueue.getNextItem(); // returns 2, queue is empty
|
|
215
|
-
* ```
|
|
216
|
-
*/
|
|
217
|
-
declare class Queuer<TValue> {
|
|
218
|
-
#private;
|
|
219
|
-
fn: (item: TValue) => void;
|
|
220
|
-
readonly store: Store<Readonly<QueuerState<TValue>>>;
|
|
221
|
-
key: string | undefined;
|
|
222
|
-
options: QueuerOptions<TValue>;
|
|
223
|
-
constructor(fn: (item: TValue) => void, initialOptions?: QueuerOptions<TValue>);
|
|
224
|
-
/**
|
|
225
|
-
* Updates the queuer options. New options are merged with existing options.
|
|
226
|
-
*/
|
|
227
|
-
setOptions: (newOptions: Partial<QueuerOptions<TValue>>) => void;
|
|
228
|
-
/**
|
|
229
|
-
* Adds an item to the queue. If the queue is full, the item is rejected and onReject is called.
|
|
230
|
-
* `undefined` cannot be queued (it is the internal "no item" sentinel) and is always rejected.
|
|
231
|
-
* Items can be inserted based on priority or at the front/back depending on configuration.
|
|
232
|
-
*
|
|
233
|
-
* Returns true if the item was added, false if the queue is full.
|
|
234
|
-
*
|
|
235
|
-
* Example usage:
|
|
236
|
-
* ```ts
|
|
237
|
-
* queuer.addItem('task');
|
|
238
|
-
* queuer.addItem('task2', 'front');
|
|
239
|
-
* ```
|
|
240
|
-
*/
|
|
241
|
-
addItem: (item: TValue, position?: QueuePosition, runOnItemsChange?: boolean) => boolean;
|
|
242
|
-
/**
|
|
243
|
-
* Removes and returns the next item from the queue without executing the function.
|
|
244
|
-
* Use for manual queue management. Normally, use execute() to process items.
|
|
245
|
-
*
|
|
246
|
-
* Example usage:
|
|
247
|
-
* ```ts
|
|
248
|
-
* // FIFO
|
|
249
|
-
* queuer.getNextItem();
|
|
250
|
-
* // LIFO
|
|
251
|
-
* queuer.getNextItem('back');
|
|
252
|
-
* ```
|
|
253
|
-
*/
|
|
254
|
-
getNextItem: (position?: QueuePosition) => TValue | undefined;
|
|
255
|
-
/**
|
|
256
|
-
* Removes and returns the next item from the queue and processes it using the provided function.
|
|
257
|
-
*
|
|
258
|
-
* Example usage:
|
|
259
|
-
* ```ts
|
|
260
|
-
* queuer.execute();
|
|
261
|
-
* // LIFO
|
|
262
|
-
* queuer.execute('back');
|
|
263
|
-
* ```
|
|
264
|
-
*/
|
|
265
|
-
execute: (position?: QueuePosition) => TValue | undefined;
|
|
266
|
-
/**
|
|
267
|
-
* Processes a specified number of items to execute immediately with no wait time
|
|
268
|
-
* If no numberOfItems is provided, all items will be processed
|
|
269
|
-
*/
|
|
270
|
-
flush: (numberOfItems?: number, position?: QueuePosition) => void;
|
|
271
|
-
/**
|
|
272
|
-
* Processes all items in the queue as a batch using the provided function as an argument
|
|
273
|
-
* The queue is cleared after processing
|
|
274
|
-
*/
|
|
275
|
-
flushAsBatch: (batchFunction: (items: Array<TValue>) => void) => void;
|
|
276
|
-
/**
|
|
277
|
-
* Returns the next item in the queue without removing it.
|
|
278
|
-
*
|
|
279
|
-
* Example usage:
|
|
280
|
-
* ```ts
|
|
281
|
-
* queuer.peekNextItem(); // front
|
|
282
|
-
* queuer.peekNextItem('back'); // back
|
|
283
|
-
* ```
|
|
284
|
-
*/
|
|
285
|
-
peekNextItem: (position?: QueuePosition) => TValue | undefined;
|
|
286
|
-
/**
|
|
287
|
-
* Returns a copy of all items in the queue.
|
|
288
|
-
*/
|
|
289
|
-
peekAllItems: () => Array<TValue>;
|
|
290
|
-
/**
|
|
291
|
-
* Starts processing items in the queue. If already isRunning, does nothing.
|
|
292
|
-
*/
|
|
293
|
-
start: () => void;
|
|
294
|
-
/**
|
|
295
|
-
* Stops processing items in the queue. Does not clear the queue.
|
|
296
|
-
*/
|
|
297
|
-
stop: () => void;
|
|
298
|
-
/**
|
|
299
|
-
* Removes all pending items from the queue. Does not affect items being processed.
|
|
300
|
-
*/
|
|
301
|
-
clear: () => void;
|
|
302
|
-
/**
|
|
303
|
-
* Resets the queuer state to its default values
|
|
304
|
-
*/
|
|
305
|
-
reset: () => void;
|
|
306
|
-
}
|
|
307
|
-
/**
|
|
308
|
-
* Creates a queue that processes items immediately upon addition.
|
|
309
|
-
* Items are processed sequentially in FIFO order by default.
|
|
310
|
-
*
|
|
311
|
-
* This synchronous version is lighter weight and often all you need - upgrade to asyncQueue when you need promises, retry support, abort capabilities, concurrent execution, or advanced error handling.
|
|
312
|
-
*
|
|
313
|
-
* State Management:
|
|
314
|
-
* - Uses TanStack Store for reactive state management
|
|
315
|
-
* - Use `initialState` to provide initial state values when creating the queuer
|
|
316
|
-
* - Use `onExecute` callback to react to item execution and implement custom logic
|
|
317
|
-
* - Use `onItemsChange` callback to react to items being added or removed from the queue
|
|
318
|
-
* - Use `onExpire` callback to react to items expiring and implement custom logic
|
|
319
|
-
* - Use `onReject` callback to react to items being rejected when the queue is full
|
|
320
|
-
* - The state includes execution count, expiration count, rejection count, and isRunning status
|
|
321
|
-
* - State can be accessed via the underlying Queuer instance's `store.state` property
|
|
322
|
-
* - When using framework adapters (React/Solid), state is accessed from the hook's state property
|
|
323
|
-
*
|
|
324
|
-
* Example usage:
|
|
325
|
-
* ```ts
|
|
326
|
-
* // Basic sequential processing
|
|
327
|
-
* const processItems = queue<number>((n) => console.log(n), {
|
|
328
|
-
* wait: 1000,
|
|
329
|
-
* onItemsChange: (queuer) => console.log(queuer.peekAllItems())
|
|
330
|
-
* });
|
|
331
|
-
* processItems(1); // Logs: 1
|
|
332
|
-
* processItems(2); // Logs: 2 after 1 completes
|
|
333
|
-
*
|
|
334
|
-
* // Priority queue
|
|
335
|
-
* const processPriority = queue<number>((n) => console.log(n), {
|
|
336
|
-
* getPriority: n => n // Higher numbers processed first
|
|
337
|
-
* });
|
|
338
|
-
* processPriority(1);
|
|
339
|
-
* processPriority(3); // Processed before 1
|
|
340
|
-
* ```
|
|
341
|
-
*/
|
|
342
|
-
declare function queue<TValue>(fn: (item: TValue) => void, initialOptions: QueuerOptions<TValue>): (item: TValue, position?: QueuePosition, runOnItemsChange?: boolean) => boolean;
|
|
343
|
-
//#endregion
|
|
344
|
-
export { QueuePosition, Queuer, QueuerOptions, QueuerState, queue, queuerOptions };
|
|
345
|
-
//# sourceMappingURL=queuer.d.cts.map
|
package/dist/queuer.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"queuer.js","names":["#setState","#checkExpiredItems","#getWait","#timeoutId","#tick","#clearTimeout","#getAllItems"],"sources":["../src/queuer.ts"],"sourcesContent":["import { Store } from '@tanstack/store'\nimport { parseFunctionOrValue } from './utils'\nimport { emitChange, pacerEventClient } from './event-client'\n\nexport interface QueuerState<TValue> {\n /**\n * Number of times addItem has been called (for reduction calculations)\n */\n addItemCount: number\n /**\n * Number of items that have been processed by the queuer\n */\n executionCount: number\n /**\n * Number of items that have been removed from the queue due to expiration\n */\n expirationCount: number\n /**\n * Whether the queuer has no items to process (items array is empty)\n */\n isEmpty: boolean\n /**\n * Whether the queuer has reached its maximum capacity\n */\n isFull: boolean\n /**\n * Whether the queuer is not currently processing any items\n */\n isIdle: boolean\n /**\n * Whether the queuer is active and will process items automatically\n */\n isRunning: boolean\n /**\n * Array of items currently waiting to be processed\n */\n items: Array<TValue>\n /**\n * Timestamps when items were added to the queue for expiration tracking\n */\n itemTimestamps: Array<number>\n /**\n * Whether the queuer has a pending timeout for processing the next item\n */\n pendingTick: boolean\n /**\n * Number of items that have been rejected from being added to the queue\n */\n rejectionCount: number\n /**\n * Number of items currently in the queue\n */\n size: number\n /**\n * Current processing status - 'idle' when not processing, 'running' when active, 'stopped' when paused\n */\n status: 'idle' | 'running' | 'stopped'\n}\n\nfunction getDefaultQueuerState<TValue>(): QueuerState<TValue> {\n return {\n executionCount: 0,\n expirationCount: 0,\n isEmpty: true,\n isFull: false,\n isIdle: true,\n isRunning: true,\n itemTimestamps: [],\n items: [],\n pendingTick: false,\n rejectionCount: 0,\n size: 0,\n status: 'idle',\n addItemCount: 0,\n }\n}\n\n/**\n * Options for configuring a Queuer instance.\n *\n * These options control queue behavior, item expiration, callbacks, and more.\n */\nexport interface QueuerOptions<TValue> {\n /**\n * Default position to add items to the queuer\n * @default 'back'\n */\n addItemsTo?: QueuePosition\n /**\n * Maximum time in milliseconds that an item can stay in the queue\n * If not provided, items will never expire\n */\n expirationDuration?: number\n /**\n * Function to determine if an item has expired\n * If provided, this overrides the expirationDuration behavior\n */\n getIsExpired?: (item: TValue, addedAt: number) => boolean\n /**\n * Default position to get items from during processing\n * @default 'front'\n */\n getItemsFrom?: QueuePosition\n /**\n * Function to determine priority of items in the queuer\n * Higher priority items will be processed first\n */\n getPriority?: (item: TValue) => number\n /**\n * Initial items to populate the queuer with\n */\n initialItems?: Array<TValue>\n /**\n * Initial state for the queuer\n */\n initialState?: Partial<QueuerState<TValue>>\n /**\n * Optional key to identify this queuer instance.\n * If provided, the queuer will be identified by this key in the devtools and PacerProvider if applicable.\n */\n key?: string\n /**\n * Maximum number of items allowed in the queuer\n */\n maxSize?: number\n /**\n * Callback fired whenever an item is removed from the queuer\n */\n onExecute?: (item: TValue, queuer: Queuer<TValue>) => void\n /**\n * Callback fired whenever an item expires in the queuer\n */\n onExpire?: (item: TValue, queuer: Queuer<TValue>) => void\n /**\n * Callback fired whenever an item is added or removed from the queuer\n */\n onItemsChange?: (queuer: Queuer<TValue>) => void\n /**\n * Callback fired whenever an item is rejected from being added to the queuer\n */\n onReject?: (item: TValue, queuer: Queuer<TValue>) => void\n /**\n * Whether the queuer should start processing tasks immediately\n */\n started?: boolean\n /**\n * Time in milliseconds to wait between processing items.\n * Can be a number or a function that returns a number.\n * @default 0\n */\n wait?: number | ((queuer: Queuer<TValue>) => number)\n}\n\n/**\n * Utility function for sharing common `QueuerOptions` options between different `Queuer` instances.\n */\nexport function queuerOptions<\n TValue = any,\n TOptions extends Partial<QueuerOptions<TValue>> = Partial<\n QueuerOptions<TValue>\n >,\n>(options: TOptions): TOptions {\n return options\n}\n\nconst defaultOptions: Omit<\n Required<QueuerOptions<any>>,\n | 'initialState'\n | 'onExecute'\n | 'onIsRunningChange'\n | 'onItemsChange'\n | 'onReject'\n | 'onExpire'\n | 'key'\n> = {\n addItemsTo: 'back',\n getItemsFrom: 'front',\n getPriority: (item) => item?.priority ?? 0,\n getIsExpired: () => false,\n expirationDuration: Infinity,\n initialItems: [],\n maxSize: Infinity,\n started: true,\n wait: 0,\n}\n\n/**\n * Position type for addItem and getNextItem operations.\n *\n * - 'front': Operate on the front of the queue (FIFO)\n * - 'back': Operate on the back of the queue (LIFO)\n */\nexport type QueuePosition = 'front' | 'back'\n\n/**\n * A flexible queue that processes items with configurable wait times, expiration, and priority.\n *\n * This synchronous version is lighter weight and often all you need - upgrade to AsyncQueuer when you need promises, retry support, abort capabilities, concurrent execution, or advanced error handling.\n *\n * Features:\n * - Automatic or manual processing of items\n * - FIFO (First In First Out), LIFO (Last In First Out), or double-ended queue behavior\n * - Priority-based ordering when getPriority is provided\n * - Item expiration and removal of stale items\n * - Callbacks for queue state changes, execution, rejection, and expiration\n *\n * Running behavior:\n * - `start()`: Begins automatically processing items in the queue (defaults to isRunning)\n * - `stop()`: Pauses processing but maintains queue state\n * - `wait`: Configurable delay between processing items\n * - `onItemsChange`/`onExecute`: Callbacks for monitoring queue state\n *\n * Manual processing is also supported when automatic processing is disabled:\n * - `execute()`: Processes the next item using the provided function\n * - `getNextItem()`: Removes and returns the next item without processing\n *\n * Queue behavior defaults to FIFO:\n * - `addItem(item)`: Adds to the back of the queue\n * - Items processed from the front of the queue\n *\n * Priority queue:\n * - Provide a `getPriority` function; higher values are processed first\n *\n * Stack (LIFO):\n * - `addItem(item, 'back')`: Adds to the back\n * - `getNextItem('back')`: Removes from the back\n *\n * Double-ended queue:\n * - `addItem(item, position)`: Adds to specified position ('front'/'back')\n * - `getNextItem(position)`: Removes from specified position\n *\n * Item expiration:\n * - `expirationDuration`: Maximum time items can stay in the queue\n * - `getIsExpired`: Function to override default expiration\n * - `onExpire`: Callback for expired items\n *\n * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the queuer\n * - Use `onExecute` callback to react to item execution and implement custom logic\n * - Use `onItemsChange` callback to react to items being added or removed from the queue\n * - Use `onExpire` callback to react to items expiring and implement custom logic\n * - Use `onReject` callback to react to items being rejected when the queue is full\n * - The state includes execution count, expiration count, rejection count, and isRunning status\n * - State can be accessed via `queuer.store.state` when using the class directly\n * - When using framework adapters (React/Solid), state is accessed from `queuer.state`\n *\n * Example usage:\n * ```ts\n * // Auto-processing queue with wait time\n * const autoQueue = new Queuer<number>((n) => console.log(n), {\n * started: true, // Begin processing immediately\n * wait: 1000, // Wait 1s between items\n * onExecute: (item, queuer) => console.log(`Processed ${item}`)\n * });\n * autoQueue.addItem(1); // Will process after 1s\n * autoQueue.addItem(2); // Will process 1s after first item\n *\n * // Manual processing queue\n * const manualQueue = new Queuer<number>((n) => console.log(n), {\n * started: false\n * });\n * manualQueue.addItem(1); // [1]\n * manualQueue.addItem(2); // [1, 2]\n * manualQueue.execute(); // logs 1, queue is [2]\n * manualQueue.getNextItem(); // returns 2, queue is empty\n * ```\n */\nexport class Queuer<TValue> {\n readonly store: Store<Readonly<QueuerState<TValue>>> = new Store(\n getDefaultQueuerState<TValue>(),\n )\n key: string | undefined\n options: QueuerOptions<TValue>\n #timeoutId: ReturnType<typeof setTimeout> | null = null\n\n constructor(\n public fn: (item: TValue) => void,\n initialOptions: QueuerOptions<TValue> = {},\n ) {\n this.key = initialOptions.key\n this.options = {\n ...defaultOptions,\n ...initialOptions,\n }\n const isInitiallyRunning =\n this.options.initialState?.isRunning ?? this.options.started ?? true\n this.#setState({\n ...this.options.initialState,\n isRunning: isInitiallyRunning,\n })\n\n if (this.options.initialState?.items) {\n if (this.store.state.isRunning) {\n this.#tick()\n }\n } else {\n for (let i = 0; i < (this.options.initialItems?.length ?? 0); i++) {\n const item = this.options.initialItems![i]!\n const isLast = i === (this.options.initialItems?.length ?? 0) - 1\n this.addItem(item, this.options.addItemsTo ?? 'back', isLast)\n }\n }\n\n if (this.key) {\n pacerEventClient.on('d-Queuer', (event) => {\n if (event.payload.key !== this.key) return\n this.#setState(\n event.payload.store.state as Partial<QueuerState<TValue>>,\n )\n this.setOptions(event.payload.options as Partial<QueuerOptions<TValue>>)\n })\n }\n }\n\n /**\n * Updates the queuer options. New options are merged with existing options.\n */\n setOptions = (newOptions: Partial<QueuerOptions<TValue>>): void => {\n this.options = { ...this.options, ...newOptions }\n }\n\n #setState = (newState: Partial<QueuerState<TValue>>): void => {\n this.store.setState((state) => {\n const combinedState = {\n ...state,\n ...newState,\n }\n\n const { items, isRunning } = combinedState\n\n const size = items.length\n const isFull = size >= (this.options.maxSize ?? Infinity)\n const isEmpty = size === 0\n const isIdle = isRunning && isEmpty\n\n const status = isIdle ? 'idle' : isRunning ? 'running' : 'stopped'\n\n return {\n ...combinedState,\n isEmpty,\n isFull,\n isIdle,\n size,\n status,\n }\n })\n emitChange('Queuer', this)\n }\n\n /**\n * Returns the current wait time (in milliseconds) between processing items.\n * If a function is provided, it is called with the queuer instance.\n */\n #getWait = (): number => {\n return parseFunctionOrValue(this.options.wait ?? 0, this)\n }\n\n /**\n * Processes items in the queue up to the wait interval. Internal use only.\n */\n #tick = () => {\n if (!this.store.state.isRunning) {\n this.#setState({ pendingTick: false })\n return\n }\n\n this.#setState({ pendingTick: true })\n\n // Check for expired items\n this.#checkExpiredItems()\n\n while (this.store.state.items.length > 0) {\n const nextItem = this.execute(this.options.getItemsFrom ?? 'front')\n if (nextItem === undefined) {\n break\n }\n\n const wait = this.#getWait()\n if (wait > 0) {\n // Use setTimeout to wait before processing next item\n this.#timeoutId = setTimeout(() => this.#tick(), wait)\n return\n }\n\n this.#tick()\n }\n this.#setState({ pendingTick: false })\n }\n\n /**\n * Adds an item to the queue. If the queue is full, the item is rejected and onReject is called.\n * `undefined` cannot be queued (it is the internal \"no item\" sentinel) and is always rejected.\n * Items can be inserted based on priority or at the front/back depending on configuration.\n *\n * Returns true if the item was added, false if the queue is full.\n *\n * Example usage:\n * ```ts\n * queuer.addItem('task');\n * queuer.addItem('task2', 'front');\n * ```\n */\n addItem = (\n item: TValue,\n position: QueuePosition = this.options.addItemsTo ?? 'back',\n runOnItemsChange: boolean = true,\n ): boolean => {\n this.#setState({\n addItemCount: this.store.state.addItemCount + 1,\n })\n\n // undefined is the internal \"no item\" sentinel (peekNextItem/getNextItem);\n // queuing it would break the processing loop and block items behind it\n if (item === undefined) {\n this.#setState({\n rejectionCount: this.store.state.rejectionCount + 1,\n })\n this.options.onReject?.(item, this)\n return false\n }\n\n if (this.store.state.items.length >= (this.options.maxSize ?? Infinity)) {\n this.#setState({\n rejectionCount: this.store.state.rejectionCount + 1,\n })\n this.options.onReject?.(item, this)\n return false\n }\n\n // Get priority either from the function or from getPriority option\n const priority =\n this.options.getPriority !== defaultOptions.getPriority\n ? this.options.getPriority!(item)\n : (item as any)?.priority\n\n const items = this.store.state.items\n const itemTimestamps = this.store.state.itemTimestamps\n\n if (priority !== undefined) {\n // Insert based on priority - higher priority items go to front\n const insertIndex = items.findIndex((existing) => {\n const existingPriority: number =\n this.options.getPriority !== defaultOptions.getPriority\n ? this.options.getPriority!(existing)\n : (existing as any)?.priority\n return existingPriority < priority\n })\n\n if (insertIndex === -1) {\n items.push(item)\n itemTimestamps.push(Date.now())\n } else {\n items.splice(insertIndex, 0, item)\n itemTimestamps.splice(insertIndex, 0, Date.now())\n }\n } else {\n if (position === 'front') {\n // Default FIFO/LIFO behavior\n items.unshift(item)\n itemTimestamps.unshift(Date.now())\n } else {\n // LIFO\n items.push(item)\n itemTimestamps.push(Date.now())\n }\n }\n\n this.#setState({\n items,\n itemTimestamps,\n })\n\n if (runOnItemsChange) {\n this.options.onItemsChange?.(this)\n }\n\n if (this.store.state.isRunning && !this.store.state.pendingTick) {\n this.#setState({ pendingTick: true })\n this.#tick()\n }\n\n return true\n }\n\n /**\n * Removes and returns the next item from the queue without executing the function.\n * Use for manual queue management. Normally, use execute() to process items.\n *\n * Example usage:\n * ```ts\n * // FIFO\n * queuer.getNextItem();\n * // LIFO\n * queuer.getNextItem('back');\n * ```\n */\n getNextItem = (\n position: QueuePosition = this.options.getItemsFrom ?? 'front',\n ): TValue | undefined => {\n const { items, itemTimestamps } = this.store.state\n let item: TValue | undefined\n\n // When priority function is provided, always get from front (highest priority)\n // Priority takes precedence over FIFO/LIFO behavior\n if (\n this.options.getPriority !== defaultOptions.getPriority ||\n position === 'front'\n ) {\n item = items[0]\n if (item !== undefined) {\n this.#setState({\n items: items.slice(1),\n itemTimestamps: itemTimestamps.slice(1),\n })\n }\n } else {\n item = items[items.length - 1]\n if (item !== undefined) {\n this.#setState({\n items: items.slice(0, -1),\n itemTimestamps: itemTimestamps.slice(0, -1),\n })\n }\n }\n\n if (item !== undefined) {\n this.options.onItemsChange?.(this)\n }\n\n return item\n }\n\n #getAllItems = (): Array<TValue> => {\n const items = this.peekAllItems()\n this.clear()\n return items\n }\n\n /**\n * Removes and returns the next item from the queue and processes it using the provided function.\n *\n * Example usage:\n * ```ts\n * queuer.execute();\n * // LIFO\n * queuer.execute('back');\n * ```\n */\n execute = (position?: QueuePosition): TValue | undefined => {\n const item = this.getNextItem(position)\n if (item !== undefined) {\n this.fn(item)\n this.#setState({\n executionCount: this.store.state.executionCount + 1,\n })\n this.options.onExecute?.(item, this)\n }\n return item\n }\n\n /**\n * Processes a specified number of items to execute immediately with no wait time\n * If no numberOfItems is provided, all items will be processed\n */\n flush = (\n numberOfItems: number = this.store.state.items.length,\n position?: QueuePosition,\n ): void => {\n this.#clearTimeout() // clear any pending timeout\n for (let i = 0; i < numberOfItems; i++) {\n this.execute(position)\n }\n this.#tick()\n }\n\n /**\n * Processes all items in the queue as a batch using the provided function as an argument\n * The queue is cleared after processing\n */\n flushAsBatch = (batchFunction: (items: Array<TValue>) => void): void => {\n const items = this.#getAllItems()\n this.clear()\n batchFunction(items)\n }\n\n /**\n * Checks for expired items in the queue and removes them. Calls onExpire for each expired item.\n * Internal use only.\n */\n #checkExpiredItems = (): void => {\n if (\n (this.options.expirationDuration ?? Infinity) === Infinity &&\n this.options.getIsExpired === defaultOptions.getIsExpired\n ) {\n return\n }\n\n const now = Date.now()\n const expiredIndices: Array<number> = []\n\n // Find indices of expired items\n for (let i = 0; i < this.store.state.items.length; i++) {\n const timestamp = this.store.state.itemTimestamps[i]\n if (timestamp === undefined) continue\n\n const item = this.store.state.items[i]\n if (item === undefined) continue\n\n const isExpired =\n this.options.getIsExpired !== defaultOptions.getIsExpired\n ? this.options.getIsExpired!(item, timestamp)\n : now - timestamp > (this.options.expirationDuration ?? Infinity)\n\n if (isExpired) {\n expiredIndices.push(i)\n }\n }\n\n // Remove expired items from back to front to maintain indices\n for (let i = expiredIndices.length - 1; i >= 0; i--) {\n const index = expiredIndices[i]\n if (index === undefined) continue\n\n const expiredItem = this.store.state.items[index]\n if (expiredItem === undefined) continue\n\n const newItems = [...this.store.state.items]\n const newTimestamps = [...this.store.state.itemTimestamps]\n newItems.splice(index, 1)\n newTimestamps.splice(index, 1)\n this.#setState({\n items: newItems,\n itemTimestamps: newTimestamps,\n expirationCount: this.store.state.expirationCount + 1,\n })\n this.options.onExpire?.(expiredItem, this)\n }\n\n if (expiredIndices.length > 0) {\n this.options.onItemsChange?.(this)\n }\n }\n\n /**\n * Returns the next item in the queue without removing it.\n *\n * Example usage:\n * ```ts\n * queuer.peekNextItem(); // front\n * queuer.peekNextItem('back'); // back\n * ```\n */\n peekNextItem = (position: QueuePosition = 'front'): TValue | undefined => {\n if (position === 'front') {\n return this.store.state.items[0]\n }\n return this.store.state.items[this.store.state.items.length - 1]\n }\n\n /**\n * Returns a copy of all items in the queue.\n */\n peekAllItems = (): Array<TValue> => {\n return [...this.store.state.items]\n }\n\n /**\n * Starts processing items in the queue. If already isRunning, does nothing.\n */\n start = () => {\n this.#setState({ isRunning: true })\n if (!this.store.state.pendingTick && this.store.state.items.length > 0) {\n this.#tick()\n }\n }\n\n /**\n * Stops processing items in the queue. Does not clear the queue.\n */\n stop = () => {\n this.#clearTimeout()\n this.#setState({ isRunning: false, pendingTick: false })\n }\n\n #clearTimeout = (): void => {\n if (this.#timeoutId) {\n clearTimeout(this.#timeoutId)\n this.#timeoutId = null\n }\n }\n\n /**\n * Removes all pending items from the queue. Does not affect items being processed.\n */\n clear = (): void => {\n this.#setState({ items: [], itemTimestamps: [] })\n this.options.onItemsChange?.(this)\n }\n\n /**\n * Resets the queuer state to its default values\n */\n reset = (): void => {\n this.#setState(getDefaultQueuerState<TValue>())\n this.options.onItemsChange?.(this)\n }\n}\n\n/**\n * Creates a queue that processes items immediately upon addition.\n * Items are processed sequentially in FIFO order by default.\n *\n * This synchronous version is lighter weight and often all you need - upgrade to asyncQueue when you need promises, retry support, abort capabilities, concurrent execution, or advanced error handling.\n *\n * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the queuer\n * - Use `onExecute` callback to react to item execution and implement custom logic\n * - Use `onItemsChange` callback to react to items being added or removed from the queue\n * - Use `onExpire` callback to react to items expiring and implement custom logic\n * - Use `onReject` callback to react to items being rejected when the queue is full\n * - The state includes execution count, expiration count, rejection count, and isRunning status\n * - State can be accessed via the underlying Queuer instance's `store.state` property\n * - When using framework adapters (React/Solid), state is accessed from the hook's state property\n *\n * Example usage:\n * ```ts\n * // Basic sequential processing\n * const processItems = queue<number>((n) => console.log(n), {\n * wait: 1000,\n * onItemsChange: (queuer) => console.log(queuer.peekAllItems())\n * });\n * processItems(1); // Logs: 1\n * processItems(2); // Logs: 2 after 1 completes\n *\n * // Priority queue\n * const processPriority = queue<number>((n) => console.log(n), {\n * getPriority: n => n // Higher numbers processed first\n * });\n * processPriority(1);\n * processPriority(3); // Processed before 1\n * ```\n */\nexport function queue<TValue>(\n fn: (item: TValue) => void,\n initialOptions: QueuerOptions<TValue>,\n) {\n const queuer = new Queuer<TValue>(fn, initialOptions)\n return queuer.addItem\n}\n"],"mappings":";;;;;AA2DA,SAAS,wBAAqD;CAC5D,OAAO;EACL,gBAAgB;EAChB,iBAAiB;EACjB,SAAS;EACT,QAAQ;EACR,QAAQ;EACR,WAAW;EACX,gBAAgB,CAAC;EACjB,OAAO,CAAC;EACR,aAAa;EACb,gBAAgB;EAChB,MAAM;EACN,QAAQ;EACR,cAAc;CAChB;AACF;;;;AAiFA,SAAgB,cAKd,SAA6B;CAC7B,OAAO;AACT;AAEA,MAAM,iBASF;CACF,YAAY;CACZ,cAAc;CACd,cAAc,SAAS,MAAM,YAAY;CACzC,oBAAoB;CACpB,oBAAoB;CACpB,cAAc,CAAC;CACf,SAAS;CACT,SAAS;CACT,MAAM;AACR;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoFA,IAAa,SAAb,MAA4B;CAM1B;CAEA,YACE,AAAO,IACP,iBAAwC,CAAC,GACzC;EAFO;eAR8C,IAAI,MACzD,sBAA8B,CAChC;oBAGmD;qBA4CrC,eAAqD;GACjE,KAAK,UAAU;IAAE,GAAG,KAAK;IAAS,GAAG;GAAW;EAClD;oBAEa,aAAiD;GAC5D,KAAK,MAAM,UAAU,UAAU;IAC7B,MAAM,gBAAgB;KACpB,GAAG;KACH,GAAG;IACL;IAEA,MAAM,EAAE,OAAO,cAAc;IAE7B,MAAM,OAAO,MAAM;IACnB,MAAM,SAAS,SAAS,KAAK,QAAQ,WAAW;IAChD,MAAM,UAAU,SAAS;IACzB,MAAM,SAAS,aAAa;IAE5B,MAAM,SAAS,SAAS,SAAS,YAAY,YAAY;IAEzD,OAAO;KACL,GAAG;KACH;KACA;KACA;KACA;KACA;IACF;GACF,CAAC;GACD,WAAW,UAAU,IAAI;EAC3B;wBAMyB;GACvB,OAAO,qBAAqB,KAAK,QAAQ,QAAQ,GAAG,IAAI;EAC1D;qBAKc;GACZ,IAAI,CAAC,KAAK,MAAM,MAAM,WAAW;IAC/B,KAAKA,UAAU,EAAE,aAAa,MAAM,CAAC;IACrC;GACF;GAEA,KAAKA,UAAU,EAAE,aAAa,KAAK,CAAC;GAGpC,KAAKC,mBAAmB;GAExB,OAAO,KAAK,MAAM,MAAM,MAAM,SAAS,GAAG;IAExC,IADiB,KAAK,QAAQ,KAAK,QAAQ,gBAAgB,OAChD,MAAM,QACf;IAGF,MAAM,OAAO,KAAKC,SAAS;IAC3B,IAAI,OAAO,GAAG;KAEZ,KAAKC,aAAa,iBAAiB,KAAKC,MAAM,GAAG,IAAI;KACrD;IACF;IAEA,KAAKA,MAAM;GACb;GACA,KAAKJ,UAAU,EAAE,aAAa,MAAM,CAAC;EACvC;kBAgBE,MACA,WAA0B,KAAK,QAAQ,cAAc,QACrD,mBAA4B,SAChB;GACZ,KAAKA,UAAU,EACb,cAAc,KAAK,MAAM,MAAM,eAAe,EAChD,CAAC;GAID,IAAI,SAAS,QAAW;IACtB,KAAKA,UAAU,EACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB,EACpD,CAAC;IACD,KAAK,QAAQ,WAAW,MAAM,IAAI;IAClC,OAAO;GACT;GAEA,IAAI,KAAK,MAAM,MAAM,MAAM,WAAW,KAAK,QAAQ,WAAW,WAAW;IACvE,KAAKA,UAAU,EACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB,EACpD,CAAC;IACD,KAAK,QAAQ,WAAW,MAAM,IAAI;IAClC,OAAO;GACT;GAGA,MAAM,WACJ,KAAK,QAAQ,gBAAgB,eAAe,cACxC,KAAK,QAAQ,YAAa,IAAI,IAC7B,MAAc;GAErB,MAAM,QAAQ,KAAK,MAAM,MAAM;GAC/B,MAAM,iBAAiB,KAAK,MAAM,MAAM;GAExC,IAAI,aAAa,QAAW;IAE1B,MAAM,cAAc,MAAM,WAAW,aAAa;KAKhD,QAHE,KAAK,QAAQ,gBAAgB,eAAe,cACxC,KAAK,QAAQ,YAAa,QAAQ,IACjC,UAAkB,YACC;IAC5B,CAAC;IAED,IAAI,gBAAgB,IAAI;KACtB,MAAM,KAAK,IAAI;KACf,eAAe,KAAK,KAAK,IAAI,CAAC;IAChC,OAAO;KACL,MAAM,OAAO,aAAa,GAAG,IAAI;KACjC,eAAe,OAAO,aAAa,GAAG,KAAK,IAAI,CAAC;IAClD;GACF,OACE,IAAI,aAAa,SAAS;IAExB,MAAM,QAAQ,IAAI;IAClB,eAAe,QAAQ,KAAK,IAAI,CAAC;GACnC,OAAO;IAEL,MAAM,KAAK,IAAI;IACf,eAAe,KAAK,KAAK,IAAI,CAAC;GAChC;GAGF,KAAKA,UAAU;IACb;IACA;GACF,CAAC;GAED,IAAI,kBACF,KAAK,QAAQ,gBAAgB,IAAI;GAGnC,IAAI,KAAK,MAAM,MAAM,aAAa,CAAC,KAAK,MAAM,MAAM,aAAa;IAC/D,KAAKA,UAAU,EAAE,aAAa,KAAK,CAAC;IACpC,KAAKI,MAAM;GACb;GAEA,OAAO;EACT;sBAeE,WAA0B,KAAK,QAAQ,gBAAgB,YAChC;GACvB,MAAM,EAAE,OAAO,mBAAmB,KAAK,MAAM;GAC7C,IAAI;GAIJ,IACE,KAAK,QAAQ,gBAAgB,eAAe,eAC5C,aAAa,SACb;IACA,OAAO,MAAM;IACb,IAAI,SAAS,QACX,KAAKJ,UAAU;KACb,OAAO,MAAM,MAAM,CAAC;KACpB,gBAAgB,eAAe,MAAM,CAAC;IACxC,CAAC;GAEL,OAAO;IACL,OAAO,MAAM,MAAM,SAAS;IAC5B,IAAI,SAAS,QACX,KAAKA,UAAU;KACb,OAAO,MAAM,MAAM,GAAG,EAAE;KACxB,gBAAgB,eAAe,MAAM,GAAG,EAAE;IAC5C,CAAC;GAEL;GAEA,IAAI,SAAS,QACX,KAAK,QAAQ,gBAAgB,IAAI;GAGnC,OAAO;EACT;4BAEoC;GAClC,MAAM,QAAQ,KAAK,aAAa;GAChC,KAAK,MAAM;GACX,OAAO;EACT;kBAYW,aAAiD;GAC1D,MAAM,OAAO,KAAK,YAAY,QAAQ;GACtC,IAAI,SAAS,QAAW;IACtB,KAAK,GAAG,IAAI;IACZ,KAAKA,UAAU,EACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB,EACpD,CAAC;IACD,KAAK,QAAQ,YAAY,MAAM,IAAI;GACrC;GACA,OAAO;EACT;gBAOE,gBAAwB,KAAK,MAAM,MAAM,MAAM,QAC/C,aACS;GACT,KAAKK,cAAc;GACnB,KAAK,IAAI,IAAI,GAAG,IAAI,eAAe,KACjC,KAAK,QAAQ,QAAQ;GAEvB,KAAKD,MAAM;EACb;uBAMgB,kBAAwD;GACtE,MAAM,QAAQ,KAAKE,aAAa;GAChC,KAAK,MAAM;GACX,cAAc,KAAK;EACrB;kCAMiC;GAC/B,KACG,KAAK,QAAQ,sBAAsB,cAAc,YAClD,KAAK,QAAQ,iBAAiB,eAAe,cAE7C;GAGF,MAAM,MAAM,KAAK,IAAI;GACrB,MAAM,iBAAgC,CAAC;GAGvC,KAAK,IAAI,IAAI,GAAG,IAAI,KAAK,MAAM,MAAM,MAAM,QAAQ,KAAK;IACtD,MAAM,YAAY,KAAK,MAAM,MAAM,eAAe;IAClD,IAAI,cAAc,QAAW;IAE7B,MAAM,OAAO,KAAK,MAAM,MAAM,MAAM;IACpC,IAAI,SAAS,QAAW;IAOxB,IAJE,KAAK,QAAQ,iBAAiB,eAAe,eACzC,KAAK,QAAQ,aAAc,MAAM,SAAS,IAC1C,MAAM,aAAa,KAAK,QAAQ,sBAAsB,WAG1D,eAAe,KAAK,CAAC;GAEzB;GAGA,KAAK,IAAI,IAAI,eAAe,SAAS,GAAG,KAAK,GAAG,KAAK;IACnD,MAAM,QAAQ,eAAe;IAC7B,IAAI,UAAU,QAAW;IAEzB,MAAM,cAAc,KAAK,MAAM,MAAM,MAAM;IAC3C,IAAI,gBAAgB,QAAW;IAE/B,MAAM,WAAW,CAAC,GAAG,KAAK,MAAM,MAAM,KAAK;IAC3C,MAAM,gBAAgB,CAAC,GAAG,KAAK,MAAM,MAAM,cAAc;IACzD,SAAS,OAAO,OAAO,CAAC;IACxB,cAAc,OAAO,OAAO,CAAC;IAC7B,KAAKN,UAAU;KACb,OAAO;KACP,gBAAgB;KAChB,iBAAiB,KAAK,MAAM,MAAM,kBAAkB;IACtD,CAAC;IACD,KAAK,QAAQ,WAAW,aAAa,IAAI;GAC3C;GAEA,IAAI,eAAe,SAAS,GAC1B,KAAK,QAAQ,gBAAgB,IAAI;EAErC;uBAWgB,WAA0B,YAAgC;GACxE,IAAI,aAAa,SACf,OAAO,KAAK,MAAM,MAAM,MAAM;GAEhC,OAAO,KAAK,MAAM,MAAM,MAAM,KAAK,MAAM,MAAM,MAAM,SAAS;EAChE;4BAKoC;GAClC,OAAO,CAAC,GAAG,KAAK,MAAM,MAAM,KAAK;EACnC;qBAKc;GACZ,KAAKA,UAAU,EAAE,WAAW,KAAK,CAAC;GAClC,IAAI,CAAC,KAAK,MAAM,MAAM,eAAe,KAAK,MAAM,MAAM,MAAM,SAAS,GACnE,KAAKI,MAAM;EAEf;oBAKa;GACX,KAAKC,cAAc;GACnB,KAAKL,UAAU;IAAE,WAAW;IAAO,aAAa;GAAM,CAAC;EACzD;6BAE4B;GAC1B,IAAI,KAAKG,YAAY;IACnB,aAAa,KAAKA,UAAU;IAC5B,KAAKA,aAAa;GACpB;EACF;qBAKoB;GAClB,KAAKH,UAAU;IAAE,OAAO,CAAC;IAAG,gBAAgB,CAAC;GAAE,CAAC;GAChD,KAAK,QAAQ,gBAAgB,IAAI;EACnC;qBAKoB;GAClB,KAAKA,UAAU,sBAA8B,CAAC;GAC9C,KAAK,QAAQ,gBAAgB,IAAI;EACnC;EA1aE,KAAK,MAAM,eAAe;EAC1B,KAAK,UAAU;GACb,GAAG;GACH,GAAG;EACL;EACA,MAAM,qBACJ,KAAK,QAAQ,cAAc,aAAa,KAAK,QAAQ,WAAW;EAClE,KAAKA,UAAU;GACb,GAAG,KAAK,QAAQ;GAChB,WAAW;EACb,CAAC;EAED,IAAI,KAAK,QAAQ,cAAc,OAC7B;OAAI,KAAK,MAAM,MAAM,WACnB,KAAKI,MAAM;EACb,OAEA,KAAK,IAAI,IAAI,GAAG,KAAK,KAAK,QAAQ,cAAc,UAAU,IAAI,KAAK;GACjE,MAAM,OAAO,KAAK,QAAQ,aAAc;GACxC,MAAM,SAAS,OAAO,KAAK,QAAQ,cAAc,UAAU,KAAK;GAChE,KAAK,QAAQ,MAAM,KAAK,QAAQ,cAAc,QAAQ,MAAM;EAC9D;EAGF,IAAI,KAAK,KACP,iBAAiB,GAAG,aAAa,UAAU;GACzC,IAAI,MAAM,QAAQ,QAAQ,KAAK,KAAK;GACpC,KAAKJ,UACH,MAAM,QAAQ,MAAM,KACtB;GACA,KAAK,WAAW,MAAM,QAAQ,OAAyC;EACzE,CAAC;CAEL;CASA;;;;;CAgCA;;;;CAOA;CA4KA;;;;;CAyDA;CA+FA;AAsBF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCA,SAAgB,MACd,IACA,gBACA;CAEA,OAAO,IADY,OAAe,IAAI,cAC1B,CAAC,CAAC;AAChB"}
|