@tanstack/pacer 0.1.0 → 0.2.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/dist/cjs/async-debouncer.cjs +60 -44
- package/dist/cjs/async-debouncer.cjs.map +1 -1
- package/dist/cjs/async-debouncer.d.cts +37 -24
- package/dist/cjs/async-queuer.cjs +149 -125
- package/dist/cjs/async-queuer.cjs.map +1 -1
- package/dist/cjs/async-queuer.d.cts +65 -48
- package/dist/cjs/async-rate-limiter.cjs +63 -46
- package/dist/cjs/async-rate-limiter.cjs.map +1 -1
- package/dist/cjs/async-rate-limiter.d.cts +39 -27
- package/dist/cjs/async-throttler.cjs +70 -47
- package/dist/cjs/async-throttler.cjs.map +1 -1
- package/dist/cjs/async-throttler.d.cts +43 -25
- package/dist/cjs/debouncer.cjs +46 -22
- package/dist/cjs/debouncer.cjs.map +1 -1
- package/dist/cjs/debouncer.d.cts +25 -11
- package/dist/cjs/index.cjs +2 -0
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/cjs/index.d.cts +2 -0
- package/dist/cjs/queuer.cjs +114 -104
- package/dist/cjs/queuer.cjs.map +1 -1
- package/dist/cjs/queuer.d.cts +53 -40
- package/dist/cjs/rate-limiter.cjs +54 -42
- package/dist/cjs/rate-limiter.cjs.map +1 -1
- package/dist/cjs/rate-limiter.d.cts +37 -45
- package/dist/cjs/throttler.cjs +61 -41
- package/dist/cjs/throttler.cjs.map +1 -1
- package/dist/cjs/throttler.d.cts +35 -22
- package/dist/cjs/types.d.cts +12 -0
- package/dist/cjs/utils.cjs +13 -0
- package/dist/cjs/utils.cjs.map +1 -0
- package/dist/cjs/utils.d.cts +1 -0
- package/dist/esm/async-debouncer.d.ts +37 -24
- package/dist/esm/async-debouncer.js +60 -44
- package/dist/esm/async-debouncer.js.map +1 -1
- package/dist/esm/async-queuer.d.ts +65 -48
- package/dist/esm/async-queuer.js +149 -125
- package/dist/esm/async-queuer.js.map +1 -1
- package/dist/esm/async-rate-limiter.d.ts +39 -27
- package/dist/esm/async-rate-limiter.js +63 -46
- package/dist/esm/async-rate-limiter.js.map +1 -1
- package/dist/esm/async-throttler.d.ts +43 -25
- package/dist/esm/async-throttler.js +70 -47
- package/dist/esm/async-throttler.js.map +1 -1
- package/dist/esm/debouncer.d.ts +25 -11
- package/dist/esm/debouncer.js +46 -22
- package/dist/esm/debouncer.js.map +1 -1
- package/dist/esm/index.d.ts +2 -0
- package/dist/esm/index.js +2 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/queuer.d.ts +53 -40
- package/dist/esm/queuer.js +114 -104
- package/dist/esm/queuer.js.map +1 -1
- package/dist/esm/rate-limiter.d.ts +37 -45
- package/dist/esm/rate-limiter.js +54 -42
- package/dist/esm/rate-limiter.js.map +1 -1
- package/dist/esm/throttler.d.ts +35 -22
- package/dist/esm/throttler.js +61 -41
- package/dist/esm/throttler.js.map +1 -1
- package/dist/esm/types.d.ts +12 -0
- package/dist/esm/utils.d.ts +1 -0
- package/dist/esm/utils.js +13 -0
- package/dist/esm/utils.js.map +1 -0
- package/package.json +8 -1
- package/src/async-debouncer.ts +90 -62
- package/src/async-queuer.ts +178 -145
- package/src/async-rate-limiter.ts +93 -67
- package/src/async-throttler.ts +98 -63
- package/src/debouncer.ts +71 -35
- package/src/index.ts +2 -0
- package/src/queuer.ts +135 -118
- package/src/rate-limiter.ts +79 -81
- package/src/throttler.ts +87 -61
- package/src/types.ts +17 -0
- package/src/utils.ts +13 -0
package/dist/cjs/queuer.cjs
CHANGED
|
@@ -3,91 +3,141 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
|
3
3
|
const defaultOptions = {
|
|
4
4
|
addItemsTo: "back",
|
|
5
5
|
getItemsFrom: "front",
|
|
6
|
-
getPriority: () => 0,
|
|
6
|
+
getPriority: (item) => (item == null ? void 0 : item.priority) ?? 0,
|
|
7
7
|
initialItems: [],
|
|
8
8
|
maxSize: Infinity,
|
|
9
9
|
onGetNextItem: () => {
|
|
10
10
|
},
|
|
11
|
-
|
|
11
|
+
onIsRunningChange: () => {
|
|
12
|
+
},
|
|
13
|
+
onItemsChange: () => {
|
|
14
|
+
},
|
|
15
|
+
onReject: () => {
|
|
12
16
|
},
|
|
13
17
|
started: false,
|
|
14
18
|
wait: 0
|
|
15
19
|
};
|
|
16
20
|
class Queuer {
|
|
17
21
|
constructor(initialOptions = defaultOptions) {
|
|
18
|
-
this.
|
|
19
|
-
this.
|
|
20
|
-
this.
|
|
21
|
-
this.
|
|
22
|
-
this.
|
|
23
|
-
this.
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
const
|
|
27
|
-
|
|
22
|
+
this._items = [];
|
|
23
|
+
this._executionCount = 0;
|
|
24
|
+
this._rejectionCount = 0;
|
|
25
|
+
this._onItemsChanges = [];
|
|
26
|
+
this._pendingTick = false;
|
|
27
|
+
this._options = { ...defaultOptions, ...initialOptions };
|
|
28
|
+
this._running = this._options.started;
|
|
29
|
+
for (let i = 0; i < this._options.initialItems.length; i++) {
|
|
30
|
+
const item = this._options.initialItems[i];
|
|
31
|
+
const isLast = i === this._options.initialItems.length - 1;
|
|
32
|
+
this.addItem(item, this._options.addItemsTo, isLast);
|
|
28
33
|
}
|
|
29
34
|
}
|
|
35
|
+
/**
|
|
36
|
+
* Updates the queuer options
|
|
37
|
+
* Returns the new options state
|
|
38
|
+
*/
|
|
39
|
+
setOptions(newOptions) {
|
|
40
|
+
this._options = { ...this._options, ...newOptions };
|
|
41
|
+
return this._options;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Returns the current queuer options
|
|
45
|
+
*/
|
|
46
|
+
getOptions() {
|
|
47
|
+
return this._options;
|
|
48
|
+
}
|
|
30
49
|
/**
|
|
31
50
|
* Processes items in the queuer
|
|
32
51
|
*/
|
|
33
52
|
tick() {
|
|
34
|
-
if (!this.
|
|
35
|
-
this.
|
|
53
|
+
if (!this._running) {
|
|
54
|
+
this._pendingTick = false;
|
|
36
55
|
return;
|
|
37
56
|
}
|
|
38
|
-
while (!this.
|
|
39
|
-
const nextItem = this.getNextItem(this.
|
|
57
|
+
while (!this.getIsEmpty()) {
|
|
58
|
+
const nextItem = this.getNextItem(this._options.getItemsFrom);
|
|
40
59
|
if (nextItem === void 0) {
|
|
41
60
|
break;
|
|
42
61
|
}
|
|
43
|
-
this.
|
|
44
|
-
if (this.
|
|
45
|
-
setTimeout(() => this.tick(), this.
|
|
62
|
+
this._onItemsChanges.forEach((cb) => cb(nextItem));
|
|
63
|
+
if (this._options.wait > 0) {
|
|
64
|
+
setTimeout(() => this.tick(), this._options.wait);
|
|
46
65
|
return;
|
|
47
66
|
}
|
|
48
67
|
this.tick();
|
|
49
68
|
}
|
|
50
|
-
this.
|
|
69
|
+
this._pendingTick = false;
|
|
51
70
|
}
|
|
52
71
|
/**
|
|
53
|
-
*
|
|
54
|
-
* Returns the new options state
|
|
72
|
+
* Stops the queuer from processing items
|
|
55
73
|
*/
|
|
56
|
-
|
|
57
|
-
this.
|
|
58
|
-
|
|
74
|
+
stop() {
|
|
75
|
+
this._running = false;
|
|
76
|
+
this._pendingTick = false;
|
|
77
|
+
this._options.onIsRunningChange(this);
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* Starts the queuer and processes items
|
|
81
|
+
*/
|
|
82
|
+
start() {
|
|
83
|
+
this._running = true;
|
|
84
|
+
if (!this._pendingTick && !this.getIsEmpty()) {
|
|
85
|
+
this._pendingTick = true;
|
|
86
|
+
this.tick();
|
|
87
|
+
}
|
|
88
|
+
this._options.onIsRunningChange(this);
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Removes all items from the queuer
|
|
92
|
+
*/
|
|
93
|
+
clear() {
|
|
94
|
+
this._items = [];
|
|
95
|
+
this._options.onItemsChange(this);
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* Resets the queuer to its initial state
|
|
99
|
+
*/
|
|
100
|
+
reset(withInitialItems) {
|
|
101
|
+
this.clear();
|
|
102
|
+
this._executionCount = 0;
|
|
103
|
+
if (withInitialItems) {
|
|
104
|
+
this._items = [...this._options.initialItems];
|
|
105
|
+
}
|
|
106
|
+
this._running = this._options.started;
|
|
59
107
|
}
|
|
60
108
|
/**
|
|
61
109
|
* Adds an item to the queuer and starts processing if not already running
|
|
62
110
|
* @returns true if item was added, false if queuer is full
|
|
63
111
|
*/
|
|
64
|
-
addItem(item, position = this.
|
|
65
|
-
if (this.
|
|
112
|
+
addItem(item, position = this._options.addItemsTo, runOnUpdate = true) {
|
|
113
|
+
if (this.getIsFull()) {
|
|
114
|
+
this._rejectionCount++;
|
|
115
|
+
this._options.onReject(item, this);
|
|
66
116
|
return false;
|
|
67
117
|
}
|
|
68
|
-
if (this.
|
|
69
|
-
const priority = this.
|
|
70
|
-
const insertIndex = this.
|
|
71
|
-
(existing) => this.
|
|
118
|
+
if (this._options.getPriority !== defaultOptions.getPriority) {
|
|
119
|
+
const priority = this._options.getPriority(item);
|
|
120
|
+
const insertIndex = this._items.findIndex(
|
|
121
|
+
(existing) => this._options.getPriority(existing) > priority
|
|
72
122
|
);
|
|
73
123
|
if (insertIndex === -1) {
|
|
74
|
-
this.
|
|
124
|
+
this._items.push(item);
|
|
75
125
|
} else {
|
|
76
|
-
this.
|
|
126
|
+
this._items.splice(insertIndex, 0, item);
|
|
77
127
|
}
|
|
78
128
|
} else {
|
|
79
129
|
if (position === "front") {
|
|
80
|
-
this.
|
|
130
|
+
this._items.unshift(item);
|
|
81
131
|
} else {
|
|
82
|
-
this.
|
|
132
|
+
this._items.push(item);
|
|
83
133
|
}
|
|
84
134
|
}
|
|
85
|
-
if (this.
|
|
86
|
-
this.
|
|
135
|
+
if (this._running && !this._pendingTick) {
|
|
136
|
+
this._pendingTick = true;
|
|
87
137
|
this.tick();
|
|
88
138
|
}
|
|
89
139
|
if (runOnUpdate) {
|
|
90
|
-
this.
|
|
140
|
+
this._options.onItemsChange(this);
|
|
91
141
|
}
|
|
92
142
|
return true;
|
|
93
143
|
}
|
|
@@ -102,17 +152,17 @@ class Queuer {
|
|
|
102
152
|
* queuer.getNextItem('back')
|
|
103
153
|
* ```
|
|
104
154
|
*/
|
|
105
|
-
getNextItem(position = this.
|
|
155
|
+
getNextItem(position = this._options.getItemsFrom) {
|
|
106
156
|
let item;
|
|
107
157
|
if (position === "front") {
|
|
108
|
-
item = this.
|
|
158
|
+
item = this._items.shift();
|
|
109
159
|
} else {
|
|
110
|
-
item = this.
|
|
160
|
+
item = this._items.pop();
|
|
111
161
|
}
|
|
112
162
|
if (item !== void 0) {
|
|
113
|
-
this.
|
|
114
|
-
this.
|
|
115
|
-
this.
|
|
163
|
+
this._executionCount++;
|
|
164
|
+
this._options.onItemsChange(this);
|
|
165
|
+
this._options.onGetNextItem(item, this);
|
|
116
166
|
}
|
|
117
167
|
return item;
|
|
118
168
|
}
|
|
@@ -122,104 +172,64 @@ class Queuer {
|
|
|
122
172
|
* @example
|
|
123
173
|
* ```ts
|
|
124
174
|
* // Look at next item to getNextItem
|
|
125
|
-
* queuer.
|
|
175
|
+
* queuer.getPeek()
|
|
126
176
|
* // Look at last item (like stack top)
|
|
127
|
-
* queuer.
|
|
177
|
+
* queuer.getPeek('back')
|
|
128
178
|
* ```
|
|
129
179
|
*/
|
|
130
|
-
|
|
180
|
+
getPeek(position = this._options.getItemsFrom) {
|
|
131
181
|
if (position === "front") {
|
|
132
|
-
return this.
|
|
182
|
+
return this._items[0];
|
|
133
183
|
}
|
|
134
|
-
return this.
|
|
184
|
+
return this._items[this._items.length - 1];
|
|
135
185
|
}
|
|
136
186
|
/**
|
|
137
187
|
* Returns true if the queuer is empty
|
|
138
188
|
*/
|
|
139
|
-
|
|
140
|
-
return this.
|
|
189
|
+
getIsEmpty() {
|
|
190
|
+
return this._items.length === 0;
|
|
141
191
|
}
|
|
142
192
|
/**
|
|
143
193
|
* Returns true if the queuer is full
|
|
144
194
|
*/
|
|
145
|
-
|
|
146
|
-
return this.
|
|
195
|
+
getIsFull() {
|
|
196
|
+
return this._items.length >= this._options.maxSize;
|
|
147
197
|
}
|
|
148
198
|
/**
|
|
149
199
|
* Returns the current size of the queuer
|
|
150
200
|
*/
|
|
151
|
-
|
|
152
|
-
return this.
|
|
153
|
-
}
|
|
154
|
-
/**
|
|
155
|
-
* Removes all items from the queuer
|
|
156
|
-
*/
|
|
157
|
-
clear() {
|
|
158
|
-
this.items = [];
|
|
159
|
-
this.options.onUpdate(this);
|
|
160
|
-
}
|
|
161
|
-
/**
|
|
162
|
-
* Resets the queuer to its initial state
|
|
163
|
-
*/
|
|
164
|
-
reset(withInitialItems) {
|
|
165
|
-
this.clear();
|
|
166
|
-
this.executionCount = 0;
|
|
167
|
-
if (withInitialItems) {
|
|
168
|
-
this.items = [...this.options.initialItems];
|
|
169
|
-
}
|
|
170
|
-
this.running = this.options.started;
|
|
201
|
+
getSize() {
|
|
202
|
+
return this._items.length;
|
|
171
203
|
}
|
|
172
204
|
/**
|
|
173
205
|
* Returns a copy of all items in the queuer
|
|
174
206
|
*/
|
|
175
207
|
getAllItems() {
|
|
176
|
-
return [...this.
|
|
208
|
+
return [...this._items];
|
|
177
209
|
}
|
|
178
210
|
/**
|
|
179
211
|
* Returns the number of items that have been removed from the queuer
|
|
180
212
|
*/
|
|
181
213
|
getExecutionCount() {
|
|
182
|
-
return this.
|
|
183
|
-
}
|
|
184
|
-
/**
|
|
185
|
-
* Adds a callback to be called when an item is processed
|
|
186
|
-
*/
|
|
187
|
-
onUpdate(cb) {
|
|
188
|
-
this.onUpdates.push(cb);
|
|
189
|
-
return () => {
|
|
190
|
-
this.onUpdates = this.onUpdates.filter((d) => d !== cb);
|
|
191
|
-
};
|
|
214
|
+
return this._executionCount;
|
|
192
215
|
}
|
|
193
216
|
/**
|
|
194
|
-
*
|
|
217
|
+
* Returns the number of items that have been rejected from the queuer
|
|
195
218
|
*/
|
|
196
|
-
|
|
197
|
-
this.
|
|
198
|
-
this.pendingTick = false;
|
|
199
|
-
this.options.onUpdate(this);
|
|
200
|
-
}
|
|
201
|
-
/**
|
|
202
|
-
* Starts the queuer and processes items
|
|
203
|
-
*/
|
|
204
|
-
start() {
|
|
205
|
-
this.running = true;
|
|
206
|
-
if (!this.pendingTick && !this.isEmpty()) {
|
|
207
|
-
this.pendingTick = true;
|
|
208
|
-
this.tick();
|
|
209
|
-
}
|
|
210
|
-
this.options.onUpdate(this);
|
|
219
|
+
getRejectionCount() {
|
|
220
|
+
return this._rejectionCount;
|
|
211
221
|
}
|
|
212
222
|
/**
|
|
213
223
|
* Returns true if the queuer is running
|
|
214
224
|
*/
|
|
215
|
-
|
|
216
|
-
return this.
|
|
225
|
+
getIsRunning() {
|
|
226
|
+
return this._running;
|
|
217
227
|
}
|
|
218
228
|
/**
|
|
219
229
|
* Returns true if the queuer is running but has no items to process
|
|
220
230
|
*/
|
|
221
|
-
|
|
222
|
-
return this.
|
|
231
|
+
getIsIdle() {
|
|
232
|
+
return this._running && this.getIsEmpty();
|
|
223
233
|
}
|
|
224
234
|
}
|
|
225
235
|
function queue(options = {}) {
|
package/dist/cjs/queuer.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"queuer.cjs","sources":["../../src/queuer.ts"],"sourcesContent":["/**\n * Options for configuring a Queuer instance\n */\nexport interface QueuerOptions<TValue> {\n /**\n * Default position to add items to the queuer\n * @default 'back'\n */\n addItemsTo?: QueuePosition\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 * 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 onGetNextItem?: (item: TValue, queuer: Queuer<TValue>) => void\n /**\n * Callback fired whenever an item is added or removed from the queuer\n */\n onUpdate?: (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 */\n wait?: number\n}\n\nconst defaultOptions: Required<QueuerOptions<any>> = {\n addItemsTo: 'back',\n getItemsFrom: 'front',\n getPriority: () => 0,\n initialItems: [],\n maxSize: Infinity,\n onGetNextItem: () => {},\n onUpdate: () => {},\n started: false,\n wait: 0,\n}\n\n/**\n * Position type for addItem and getNextItem operations\n */\nexport type QueuePosition = 'front' | 'back'\n\n/**\n * A flexible queue data structure that defaults to FIFO (First In First Out) behavior\n * with optional position overrides for stack-like or double-ended operations.\n *\n * The queuer can automatically process items as they are added, with configurable\n * wait times between processing each item. Processing can be started/stopped\n * and the queuer will maintain its state.\n *\n * Supports priority-based ordering when a getPriority function is provided.\n * Items with higher priority values will be processed first.\n *\n * Default queue behavior:\n * - addItem(item): adds to back of queuer\n * - getNextItem(): removes and returns from front of queuer\n *\n * Stack (LIFO) behavior:\n * - addItem(item, 'back'): adds to back\n * - getNextItem('back'): removes and returns from back\n *\n * Double-ended queuer behavior:\n * - addItem(item, position): adds to specified position ('front' or 'back')\n * - getNextItem(position): removes and returns from specified position\n *\n * Processing behavior:\n * - start(): begins processing items in the queuer\n * - stop(): pauses processing\n * - wait: configurable delay between processing items\n * - onUpdate/onGetNextItem: callbacks for monitoring queuer state\n *\n * @example\n * ```ts\n * // FIFO queuer\n * const queuer = new Queuer<number>();\n * queuer.addItem(1); // [1]\n * queuer.addItem(2); // [1, 2]\n * queuer.getNextItem(); // returns 1, queuer is [2]\n *\n * // Priority queuer with processing\n * const priorityQueue = new Queuer<number>({\n * getPriority: (n) => n, // Higher numbers have priority\n * started: true, // Begin processing immediately\n * wait: 1000, // Wait 1s between items\n * onGetNextItem: (item) => console.log(item)\n * });\n * priorityQueue.addItem(1); // [1]\n * priorityQueue.addItem(3); // [3, 1] - 3 processed first\n * priorityQueue.addItem(2); // [3, 2, 1]\n * ```\n */\nexport class Queuer<TValue> {\n protected options: Required<QueuerOptions<TValue>>\n private items: Array<TValue> = []\n private executionCount = 0\n private onUpdates: Array<(item: TValue) => void> = []\n private running: boolean\n private pendingTick = false\n\n constructor(initialOptions: QueuerOptions<TValue> = defaultOptions) {\n this.options = { ...defaultOptions, ...initialOptions }\n this.running = this.options.started\n\n for (let i = 0; i < this.options.initialItems.length; i++) {\n const item = this.options.initialItems[i]!\n const isLast = i === this.options.initialItems.length - 1\n this.addItem(item, this.options.addItemsTo, isLast)\n }\n }\n\n /**\n * Processes items in the queuer\n */\n protected tick() {\n if (!this.running) {\n this.pendingTick = false\n return\n }\n while (!this.isEmpty()) {\n const nextItem = this.getNextItem(this.options.getItemsFrom)\n if (nextItem === undefined) {\n break\n }\n this.onUpdates.forEach((cb) => cb(nextItem))\n\n if (this.options.wait > 0) {\n // Use setTimeout to wait before processing next item\n setTimeout(() => this.tick(), this.options.wait)\n return\n }\n\n this.tick()\n }\n this.pendingTick = false\n }\n\n /**\n * Updates the queuer options\n * Returns the new options state\n */\n setOptions(\n newOptions: Partial<QueuerOptions<TValue>>,\n ): QueuerOptions<TValue> {\n this.options = { ...this.options, ...newOptions }\n return this.options\n }\n\n /**\n * Adds an item to the queuer and starts processing if not already running\n * @returns true if item was added, false if queuer is full\n */\n addItem(\n item: TValue,\n position: QueuePosition = this.options.addItemsTo,\n runOnUpdate: boolean = true,\n ): boolean {\n if (this.isFull()) {\n return false\n }\n\n if (this.options.getPriority !== defaultOptions.getPriority) {\n // If custom priority function is provided, insert based on priority\n const priority = this.options.getPriority(item)\n const insertIndex = this.items.findIndex(\n (existing) => this.options.getPriority(existing) > priority,\n )\n\n if (insertIndex === -1) {\n this.items.push(item)\n } else {\n this.items.splice(insertIndex, 0, item)\n }\n } else {\n // Default FIFO/LIFO behavior\n if (position === 'front') {\n this.items.unshift(item)\n } else {\n this.items.push(item)\n }\n }\n\n if (this.running && !this.pendingTick) {\n this.pendingTick = true\n this.tick()\n }\n if (runOnUpdate) {\n this.options.onUpdate(this)\n }\n return true\n }\n\n /**\n * Removes and returns an item from the queuer using shift (default) or pop\n *\n * @example\n * ```ts\n * // Standard FIFO queuer\n * queuer.getNextItem()\n * // Stack-like behavior (LIFO)\n * queuer.getNextItem('back')\n * ```\n */\n getNextItem(\n position: QueuePosition = this.options.getItemsFrom,\n ): TValue | undefined {\n let item: TValue | undefined\n\n if (position === 'front') {\n item = this.items.shift()\n } else {\n item = this.items.pop()\n }\n\n if (item !== undefined) {\n this.executionCount++\n this.options.onUpdate(this)\n this.options.onGetNextItem(item, this)\n }\n return item\n }\n\n /**\n * Returns an item without removing it\n *\n * @example\n * ```ts\n * // Look at next item to getNextItem\n * queuer.peek()\n * // Look at last item (like stack top)\n * queuer.peek('back')\n * ```\n */\n peek(\n position: QueuePosition = this.options.getItemsFrom,\n ): TValue | undefined {\n if (position === 'front') {\n return this.items[0]\n }\n return this.items[this.items.length - 1]\n }\n\n /**\n * Returns true if the queuer is empty\n */\n isEmpty(): boolean {\n return this.items.length === 0\n }\n\n /**\n * Returns true if the queuer is full\n */\n isFull(): boolean {\n return this.items.length >= this.options.maxSize\n }\n\n /**\n * Returns the current size of the queuer\n */\n size(): number {\n return this.items.length\n }\n\n /**\n * Removes all items from the queuer\n */\n clear(): void {\n this.items = []\n this.options.onUpdate(this)\n }\n\n /**\n * Resets the queuer to its initial state\n */\n reset(withInitialItems?: boolean): void {\n this.clear()\n this.executionCount = 0\n if (withInitialItems) {\n this.items = [...this.options.initialItems]\n }\n this.running = this.options.started\n }\n\n /**\n * Returns a copy of all items in the queuer\n */\n getAllItems(): Array<TValue> {\n return [...this.items]\n }\n\n /**\n * Returns the number of items that have been removed from the queuer\n */\n getExecutionCount(): number {\n return this.executionCount\n }\n\n /**\n * Adds a callback to be called when an item is processed\n */\n onUpdate(cb: (item: TValue) => void) {\n this.onUpdates.push(cb)\n return () => {\n this.onUpdates = this.onUpdates.filter((d) => d !== cb)\n }\n }\n\n /**\n * Stops the queuer from processing items\n */\n stop() {\n this.running = false\n this.pendingTick = false\n this.options.onUpdate(this)\n }\n\n /**\n * Starts the queuer and processes items\n */\n start() {\n this.running = true\n if (!this.pendingTick && !this.isEmpty()) {\n this.pendingTick = true\n this.tick()\n }\n this.options.onUpdate(this)\n }\n\n /**\n * Returns true if the queuer is running\n */\n isRunning() {\n return this.running\n }\n\n /**\n * Returns true if the queuer is running but has no items to process\n */\n isIdle() {\n return this.running && this.isEmpty()\n }\n}\n\n/**\n * Creates a queue that processes items in a queuer immediately upon addition.\n * Items are processed sequentially in FIFO order by default.\n *\n * This is a simplified wrapper around the Queuer class that only exposes the\n * `addItem` method. This queue is always running and will process items as they are added.\n * For more control over queuer processing, use the Queuer class\n * directly which provides methods like `start`, `stop`, `reset`, and more.\n *\n * @example\n * ```ts\n * // Basic sequential processing\n * const processItems = queuer<number>({\n * wait: 1000,\n * onUpdate: (queuer) => console.log(queuer.getAllItems())\n * })\n * processItems(1) // Logs: 1\n * processItems(2) // Logs: 2 after 1 completes\n *\n * // Priority queuer\n * const processPriority = queuer<number>({\n * process: async (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>(options: QueuerOptions<TValue> = {}) {\n const queuer = new Queuer<TValue>({ ...options, started: true })\n return queuer.addItem.bind(queuer)\n}\n"],"names":[],"mappings":";;AA6CA,MAAM,iBAA+C;AAAA,EACnD,YAAY;AAAA,EACZ,cAAc;AAAA,EACd,aAAa,MAAM;AAAA,EACnB,cAAc,CAAC;AAAA,EACf,SAAS;AAAA,EACT,eAAe,MAAM;AAAA,EAAC;AAAA,EACtB,UAAU,MAAM;AAAA,EAAC;AAAA,EACjB,SAAS;AAAA,EACT,MAAM;AACR;AAwDO,MAAM,OAAe;AAAA,EAQ1B,YAAY,iBAAwC,gBAAgB;AANpE,SAAQ,QAAuB,CAAC;AAChC,SAAQ,iBAAiB;AACzB,SAAQ,YAA2C,CAAC;AAEpD,SAAQ,cAAc;AAGpB,SAAK,UAAU,EAAE,GAAG,gBAAgB,GAAG,eAAe;AACjD,SAAA,UAAU,KAAK,QAAQ;AAE5B,aAAS,IAAI,GAAG,IAAI,KAAK,QAAQ,aAAa,QAAQ,KAAK;AACzD,YAAM,OAAO,KAAK,QAAQ,aAAa,CAAC;AACxC,YAAM,SAAS,MAAM,KAAK,QAAQ,aAAa,SAAS;AACxD,WAAK,QAAQ,MAAM,KAAK,QAAQ,YAAY,MAAM;AAAA,IAAA;AAAA,EACpD;AAAA;AAAA;AAAA;AAAA,EAMQ,OAAO;AACX,QAAA,CAAC,KAAK,SAAS;AACjB,WAAK,cAAc;AACnB;AAAA,IAAA;AAEK,WAAA,CAAC,KAAK,WAAW;AACtB,YAAM,WAAW,KAAK,YAAY,KAAK,QAAQ,YAAY;AAC3D,UAAI,aAAa,QAAW;AAC1B;AAAA,MAAA;AAEF,WAAK,UAAU,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC;AAEvC,UAAA,KAAK,QAAQ,OAAO,GAAG;AAEzB,mBAAW,MAAM,KAAK,KAAQ,GAAA,KAAK,QAAQ,IAAI;AAC/C;AAAA,MAAA;AAGF,WAAK,KAAK;AAAA,IAAA;AAEZ,SAAK,cAAc;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOrB,WACE,YACuB;AACvB,SAAK,UAAU,EAAE,GAAG,KAAK,SAAS,GAAG,WAAW;AAChD,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOd,QACE,MACA,WAA0B,KAAK,QAAQ,YACvC,cAAuB,MACd;AACL,QAAA,KAAK,UAAU;AACV,aAAA;AAAA,IAAA;AAGT,QAAI,KAAK,QAAQ,gBAAgB,eAAe,aAAa;AAE3D,YAAM,WAAW,KAAK,QAAQ,YAAY,IAAI;AACxC,YAAA,cAAc,KAAK,MAAM;AAAA,QAC7B,CAAC,aAAa,KAAK,QAAQ,YAAY,QAAQ,IAAI;AAAA,MACrD;AAEA,UAAI,gBAAgB,IAAI;AACjB,aAAA,MAAM,KAAK,IAAI;AAAA,MAAA,OACf;AACL,aAAK,MAAM,OAAO,aAAa,GAAG,IAAI;AAAA,MAAA;AAAA,IACxC,OACK;AAEL,UAAI,aAAa,SAAS;AACnB,aAAA,MAAM,QAAQ,IAAI;AAAA,MAAA,OAClB;AACA,aAAA,MAAM,KAAK,IAAI;AAAA,MAAA;AAAA,IACtB;AAGF,QAAI,KAAK,WAAW,CAAC,KAAK,aAAa;AACrC,WAAK,cAAc;AACnB,WAAK,KAAK;AAAA,IAAA;AAEZ,QAAI,aAAa;AACV,WAAA,QAAQ,SAAS,IAAI;AAAA,IAAA;AAErB,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcT,YACE,WAA0B,KAAK,QAAQ,cACnB;AAChB,QAAA;AAEJ,QAAI,aAAa,SAAS;AACjB,aAAA,KAAK,MAAM,MAAM;AAAA,IAAA,OACnB;AACE,aAAA,KAAK,MAAM,IAAI;AAAA,IAAA;AAGxB,QAAI,SAAS,QAAW;AACjB,WAAA;AACA,WAAA,QAAQ,SAAS,IAAI;AACrB,WAAA,QAAQ,cAAc,MAAM,IAAI;AAAA,IAAA;AAEhC,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcT,KACE,WAA0B,KAAK,QAAQ,cACnB;AACpB,QAAI,aAAa,SAAS;AACjB,aAAA,KAAK,MAAM,CAAC;AAAA,IAAA;AAErB,WAAO,KAAK,MAAM,KAAK,MAAM,SAAS,CAAC;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMzC,UAAmB;AACV,WAAA,KAAK,MAAM,WAAW;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM/B,SAAkB;AAChB,WAAO,KAAK,MAAM,UAAU,KAAK,QAAQ;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM3C,OAAe;AACb,WAAO,KAAK,MAAM;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMpB,QAAc;AACZ,SAAK,QAAQ,CAAC;AACT,SAAA,QAAQ,SAAS,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM5B,MAAM,kBAAkC;AACtC,SAAK,MAAM;AACX,SAAK,iBAAiB;AACtB,QAAI,kBAAkB;AACpB,WAAK,QAAQ,CAAC,GAAG,KAAK,QAAQ,YAAY;AAAA,IAAA;AAEvC,SAAA,UAAU,KAAK,QAAQ;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM9B,cAA6B;AACpB,WAAA,CAAC,GAAG,KAAK,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMvB,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,SAAS,IAA4B;AAC9B,SAAA,UAAU,KAAK,EAAE;AACtB,WAAO,MAAM;AACX,WAAK,YAAY,KAAK,UAAU,OAAO,CAAC,MAAM,MAAM,EAAE;AAAA,IACxD;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMF,OAAO;AACL,SAAK,UAAU;AACf,SAAK,cAAc;AACd,SAAA,QAAQ,SAAS,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM5B,QAAQ;AACN,SAAK,UAAU;AACf,QAAI,CAAC,KAAK,eAAe,CAAC,KAAK,WAAW;AACxC,WAAK,cAAc;AACnB,WAAK,KAAK;AAAA,IAAA;AAEP,SAAA,QAAQ,SAAS,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM5B,YAAY;AACV,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,SAAS;AACA,WAAA,KAAK,WAAW,KAAK,QAAQ;AAAA,EAAA;AAExC;AA8BgB,SAAA,MAAc,UAAiC,IAAI;AAC3D,QAAA,SAAS,IAAI,OAAe,EAAE,GAAG,SAAS,SAAS,MAAM;AACxD,SAAA,OAAO,QAAQ,KAAK,MAAM;AACnC;;;"}
|
|
1
|
+
{"version":3,"file":"queuer.cjs","sources":["../../src/queuer.ts"],"sourcesContent":["/**\n * Options for configuring a Queuer instance\n */\nexport interface QueuerOptions<TValue> {\n /**\n * Default position to add items to the queuer\n * @default 'back'\n */\n addItemsTo?: QueuePosition\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 * 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 onGetNextItem?: (item: TValue, queuer: Queuer<TValue>) => void\n /**\n * Callback fired whenever the queuer's running state changes\n */\n onIsRunningChange?: (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 */\n wait?: number\n}\n\nconst defaultOptions: Required<QueuerOptions<any>> = {\n addItemsTo: 'back',\n getItemsFrom: 'front',\n getPriority: (item) => item?.priority ?? 0,\n initialItems: [],\n maxSize: Infinity,\n onGetNextItem: () => {},\n onIsRunningChange: () => {},\n onItemsChange: () => {},\n onReject: () => {},\n started: false,\n wait: 0,\n}\n\n/**\n * Position type for addItem and getNextItem operations\n */\nexport type QueuePosition = 'front' | 'back'\n\n/**\n * A flexible queue data structure that defaults to FIFO (First In First Out) behavior\n * with optional position overrides for stack-like or double-ended operations.\n *\n * The queuer can automatically process items as they are added, with configurable\n * wait times between processing each item. Processing can be started/stopped\n * and the queuer will maintain its state.\n *\n * Supports priority-based ordering when a getPriority function is provided.\n * Items with higher priority values will be processed first.\n *\n * Default queue behavior:\n * - addItem(item): adds to back of queuer\n * - getNextItem(): removes and returns from front of queuer\n *\n * Stack (LIFO) behavior:\n * - addItem(item, 'back'): adds to back\n * - getNextItem('back'): removes and returns from back\n *\n * Double-ended queuer behavior:\n * - addItem(item, position): adds to specified position ('front' or 'back')\n * - getNextItem(position): removes and returns from specified position\n *\n * Processing behavior:\n * - start(): begins processing items in the queuer\n * - stop(): pauses processing\n * - wait: configurable delay between processing items\n * - onItemsChange/onGetNextItem: callbacks for monitoring queuer state\n *\n * @example\n * ```ts\n * // FIFO queuer\n * const queuer = new Queuer<number>();\n * queuer.addItem(1); // [1]\n * queuer.addItem(2); // [1, 2]\n * queuer.getNextItem(); // returns 1, queuer is [2]\n *\n * // Priority queuer with processing\n * const priorityQueue = new Queuer<number>({\n * getPriority: (n) => n, // Higher numbers have priority\n * started: true, // Begin processing immediately\n * wait: 1000, // Wait 1s between items\n * onGetNextItem: (item, queuer) => console.log(item)\n * });\n * priorityQueue.addItem(1); // [1]\n * priorityQueue.addItem(3); // [3, 1] - 3 processed first\n * priorityQueue.addItem(2); // [3, 2, 1]\n * ```\n */\nexport class Queuer<TValue> {\n private _options: Required<QueuerOptions<TValue>>\n private _items: Array<TValue> = []\n private _executionCount = 0\n private _rejectionCount = 0\n private _onItemsChanges: Array<(item: TValue) => void> = []\n private _running: boolean\n private _pendingTick = false\n\n constructor(initialOptions: QueuerOptions<TValue> = defaultOptions) {\n this._options = { ...defaultOptions, ...initialOptions }\n this._running = this._options.started\n\n for (let i = 0; i < this._options.initialItems.length; i++) {\n const item = this._options.initialItems[i]!\n const isLast = i === this._options.initialItems.length - 1\n this.addItem(item, this._options.addItemsTo, isLast)\n }\n }\n\n /**\n * Updates the queuer options\n * Returns the new options state\n */\n setOptions(\n newOptions: Partial<QueuerOptions<TValue>>,\n ): QueuerOptions<TValue> {\n this._options = { ...this._options, ...newOptions }\n return this._options\n }\n\n /**\n * Returns the current queuer options\n */\n getOptions(): Required<QueuerOptions<TValue>> {\n return this._options\n }\n\n /**\n * Processes items in the queuer\n */\n private tick() {\n if (!this._running) {\n this._pendingTick = false\n return\n }\n while (!this.getIsEmpty()) {\n const nextItem = this.getNextItem(this._options.getItemsFrom)\n if (nextItem === undefined) {\n break\n }\n this._onItemsChanges.forEach((cb) => cb(nextItem))\n\n if (this._options.wait > 0) {\n // Use setTimeout to wait before processing next item\n setTimeout(() => this.tick(), this._options.wait)\n return\n }\n\n this.tick()\n }\n this._pendingTick = false\n }\n\n /**\n * Stops the queuer from processing items\n */\n stop() {\n this._running = false\n this._pendingTick = false\n this._options.onIsRunningChange(this)\n }\n\n /**\n * Starts the queuer and processes items\n */\n start() {\n this._running = true\n if (!this._pendingTick && !this.getIsEmpty()) {\n this._pendingTick = true\n this.tick()\n }\n this._options.onIsRunningChange(this)\n }\n\n /**\n * Removes all items from the queuer\n */\n clear(): void {\n this._items = []\n this._options.onItemsChange(this)\n }\n\n /**\n * Resets the queuer to its initial state\n */\n reset(withInitialItems?: boolean): void {\n this.clear()\n this._executionCount = 0\n if (withInitialItems) {\n this._items = [...this._options.initialItems]\n }\n this._running = this._options.started\n }\n\n /**\n * Adds an item to the queuer and starts processing if not already running\n * @returns true if item was added, false if queuer is full\n */\n addItem(\n item: TValue,\n position: QueuePosition = this._options.addItemsTo,\n runOnUpdate: boolean = true,\n ): boolean {\n if (this.getIsFull()) {\n this._rejectionCount++\n this._options.onReject(item, this)\n return false\n }\n\n if (this._options.getPriority !== defaultOptions.getPriority) {\n // If custom priority function is provided, insert based on priority\n const priority = this._options.getPriority(item)\n const insertIndex = this._items.findIndex(\n (existing) => this._options.getPriority(existing) > priority,\n )\n\n if (insertIndex === -1) {\n this._items.push(item)\n } else {\n this._items.splice(insertIndex, 0, item)\n }\n } else {\n // Default FIFO/LIFO behavior\n if (position === 'front') {\n this._items.unshift(item)\n } else {\n this._items.push(item)\n }\n }\n\n if (this._running && !this._pendingTick) {\n this._pendingTick = true\n this.tick()\n }\n if (runOnUpdate) {\n this._options.onItemsChange(this)\n }\n return true\n }\n\n /**\n * Removes and returns an item from the queuer using shift (default) or pop\n *\n * @example\n * ```ts\n * // Standard FIFO queuer\n * queuer.getNextItem()\n * // Stack-like behavior (LIFO)\n * queuer.getNextItem('back')\n * ```\n */\n getNextItem(\n position: QueuePosition = this._options.getItemsFrom,\n ): TValue | undefined {\n let item: TValue | undefined\n\n if (position === 'front') {\n item = this._items.shift()\n } else {\n item = this._items.pop()\n }\n\n if (item !== undefined) {\n this._executionCount++\n this._options.onItemsChange(this)\n this._options.onGetNextItem(item, this)\n }\n return item\n }\n\n /**\n * Returns an item without removing it\n *\n * @example\n * ```ts\n * // Look at next item to getNextItem\n * queuer.getPeek()\n * // Look at last item (like stack top)\n * queuer.getPeek('back')\n * ```\n */\n getPeek(\n position: QueuePosition = this._options.getItemsFrom,\n ): TValue | undefined {\n if (position === 'front') {\n return this._items[0]\n }\n return this._items[this._items.length - 1]\n }\n\n /**\n * Returns true if the queuer is empty\n */\n getIsEmpty(): boolean {\n return this._items.length === 0\n }\n\n /**\n * Returns true if the queuer is full\n */\n getIsFull(): boolean {\n return this._items.length >= this._options.maxSize\n }\n\n /**\n * Returns the current size of the queuer\n */\n getSize(): number {\n return this._items.length\n }\n\n /**\n * Returns a copy of all items in the queuer\n */\n getAllItems(): Array<TValue> {\n return [...this._items]\n }\n\n /**\n * Returns the number of items that have been removed from the queuer\n */\n getExecutionCount(): number {\n return this._executionCount\n }\n\n /**\n * Returns the number of items that have been rejected from the queuer\n */\n getRejectionCount(): number {\n return this._rejectionCount\n }\n\n /**\n * Returns true if the queuer is running\n */\n getIsRunning() {\n return this._running\n }\n\n /**\n * Returns true if the queuer is running but has no items to process\n */\n getIsIdle() {\n return this._running && this.getIsEmpty()\n }\n}\n\n/**\n * Creates a queue that processes items in a queuer immediately upon addition.\n * Items are processed sequentially in FIFO order by default.\n *\n * This is a simplified wrapper around the Queuer class that only exposes the\n * `addItem` method. This queue is always running and will process items as they are added.\n * For more control over queuer processing, use the Queuer class\n * directly which provides methods like `start`, `stop`, `reset`, and more.\n *\n * @example\n * ```ts\n * // Basic sequential processing\n * const processItems = queuer<number>({\n * wait: 1000,\n * onItemsChange: (queuer) => console.log(queuer.getAllItems())\n * })\n * processItems(1) // Logs: 1\n * processItems(2) // Logs: 2 after 1 completes\n *\n * // Priority queuer\n * const processPriority = queuer<number>({\n * process: async (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>(options: QueuerOptions<TValue> = {}) {\n const queuer = new Queuer<TValue>({ ...options, started: true })\n return queuer.addItem.bind(queuer)\n}\n"],"names":[],"mappings":";;AAqDA,MAAM,iBAA+C;AAAA,EACnD,YAAY;AAAA,EACZ,cAAc;AAAA,EACd,aAAa,CAAC,UAAS,6BAAM,aAAY;AAAA,EACzC,cAAc,CAAC;AAAA,EACf,SAAS;AAAA,EACT,eAAe,MAAM;AAAA,EAAC;AAAA,EACtB,mBAAmB,MAAM;AAAA,EAAC;AAAA,EAC1B,eAAe,MAAM;AAAA,EAAC;AAAA,EACtB,UAAU,MAAM;AAAA,EAAC;AAAA,EACjB,SAAS;AAAA,EACT,MAAM;AACR;AAwDO,MAAM,OAAe;AAAA,EAS1B,YAAY,iBAAwC,gBAAgB;AAPpE,SAAQ,SAAwB,CAAC;AACjC,SAAQ,kBAAkB;AAC1B,SAAQ,kBAAkB;AAC1B,SAAQ,kBAAiD,CAAC;AAE1D,SAAQ,eAAe;AAGrB,SAAK,WAAW,EAAE,GAAG,gBAAgB,GAAG,eAAe;AAClD,SAAA,WAAW,KAAK,SAAS;AAE9B,aAAS,IAAI,GAAG,IAAI,KAAK,SAAS,aAAa,QAAQ,KAAK;AAC1D,YAAM,OAAO,KAAK,SAAS,aAAa,CAAC;AACzC,YAAM,SAAS,MAAM,KAAK,SAAS,aAAa,SAAS;AACzD,WAAK,QAAQ,MAAM,KAAK,SAAS,YAAY,MAAM;AAAA,IAAA;AAAA,EACrD;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WACE,YACuB;AACvB,SAAK,WAAW,EAAE,GAAG,KAAK,UAAU,GAAG,WAAW;AAClD,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,aAA8C;AAC5C,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMN,OAAO;AACT,QAAA,CAAC,KAAK,UAAU;AAClB,WAAK,eAAe;AACpB;AAAA,IAAA;AAEK,WAAA,CAAC,KAAK,cAAc;AACzB,YAAM,WAAW,KAAK,YAAY,KAAK,SAAS,YAAY;AAC5D,UAAI,aAAa,QAAW;AAC1B;AAAA,MAAA;AAEF,WAAK,gBAAgB,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC;AAE7C,UAAA,KAAK,SAAS,OAAO,GAAG;AAE1B,mBAAW,MAAM,KAAK,KAAQ,GAAA,KAAK,SAAS,IAAI;AAChD;AAAA,MAAA;AAGF,WAAK,KAAK;AAAA,IAAA;AAEZ,SAAK,eAAe;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMtB,OAAO;AACL,SAAK,WAAW;AAChB,SAAK,eAAe;AACf,SAAA,SAAS,kBAAkB,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMtC,QAAQ;AACN,SAAK,WAAW;AAChB,QAAI,CAAC,KAAK,gBAAgB,CAAC,KAAK,cAAc;AAC5C,WAAK,eAAe;AACpB,WAAK,KAAK;AAAA,IAAA;AAEP,SAAA,SAAS,kBAAkB,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMtC,QAAc;AACZ,SAAK,SAAS,CAAC;AACV,SAAA,SAAS,cAAc,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMlC,MAAM,kBAAkC;AACtC,SAAK,MAAM;AACX,SAAK,kBAAkB;AACvB,QAAI,kBAAkB;AACpB,WAAK,SAAS,CAAC,GAAG,KAAK,SAAS,YAAY;AAAA,IAAA;AAEzC,SAAA,WAAW,KAAK,SAAS;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOhC,QACE,MACA,WAA0B,KAAK,SAAS,YACxC,cAAuB,MACd;AACL,QAAA,KAAK,aAAa;AACf,WAAA;AACA,WAAA,SAAS,SAAS,MAAM,IAAI;AAC1B,aAAA;AAAA,IAAA;AAGT,QAAI,KAAK,SAAS,gBAAgB,eAAe,aAAa;AAE5D,YAAM,WAAW,KAAK,SAAS,YAAY,IAAI;AACzC,YAAA,cAAc,KAAK,OAAO;AAAA,QAC9B,CAAC,aAAa,KAAK,SAAS,YAAY,QAAQ,IAAI;AAAA,MACtD;AAEA,UAAI,gBAAgB,IAAI;AACjB,aAAA,OAAO,KAAK,IAAI;AAAA,MAAA,OAChB;AACL,aAAK,OAAO,OAAO,aAAa,GAAG,IAAI;AAAA,MAAA;AAAA,IACzC,OACK;AAEL,UAAI,aAAa,SAAS;AACnB,aAAA,OAAO,QAAQ,IAAI;AAAA,MAAA,OACnB;AACA,aAAA,OAAO,KAAK,IAAI;AAAA,MAAA;AAAA,IACvB;AAGF,QAAI,KAAK,YAAY,CAAC,KAAK,cAAc;AACvC,WAAK,eAAe;AACpB,WAAK,KAAK;AAAA,IAAA;AAEZ,QAAI,aAAa;AACV,WAAA,SAAS,cAAc,IAAI;AAAA,IAAA;AAE3B,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcT,YACE,WAA0B,KAAK,SAAS,cACpB;AAChB,QAAA;AAEJ,QAAI,aAAa,SAAS;AACjB,aAAA,KAAK,OAAO,MAAM;AAAA,IAAA,OACpB;AACE,aAAA,KAAK,OAAO,IAAI;AAAA,IAAA;AAGzB,QAAI,SAAS,QAAW;AACjB,WAAA;AACA,WAAA,SAAS,cAAc,IAAI;AAC3B,WAAA,SAAS,cAAc,MAAM,IAAI;AAAA,IAAA;AAEjC,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcT,QACE,WAA0B,KAAK,SAAS,cACpB;AACpB,QAAI,aAAa,SAAS;AACjB,aAAA,KAAK,OAAO,CAAC;AAAA,IAAA;AAEtB,WAAO,KAAK,OAAO,KAAK,OAAO,SAAS,CAAC;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM3C,aAAsB;AACb,WAAA,KAAK,OAAO,WAAW;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMhC,YAAqB;AACnB,WAAO,KAAK,OAAO,UAAU,KAAK,SAAS;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM7C,UAAkB;AAChB,WAAO,KAAK,OAAO;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMrB,cAA6B;AACpB,WAAA,CAAC,GAAG,KAAK,MAAM;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMxB,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,eAAe;AACb,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,YAAY;AACH,WAAA,KAAK,YAAY,KAAK,WAAW;AAAA,EAAA;AAE5C;AA8BgB,SAAA,MAAc,UAAiC,IAAI;AAC3D,QAAA,SAAS,IAAI,OAAe,EAAE,GAAG,SAAS,SAAS,MAAM;AACxD,SAAA,OAAO,QAAQ,KAAK,MAAM;AACnC;;;"}
|
package/dist/cjs/queuer.d.cts
CHANGED
|
@@ -29,10 +29,18 @@ export interface QueuerOptions<TValue> {
|
|
|
29
29
|
* Callback fired whenever an item is removed from the queuer
|
|
30
30
|
*/
|
|
31
31
|
onGetNextItem?: (item: TValue, queuer: Queuer<TValue>) => void;
|
|
32
|
+
/**
|
|
33
|
+
* Callback fired whenever the queuer's running state changes
|
|
34
|
+
*/
|
|
35
|
+
onIsRunningChange?: (queuer: Queuer<TValue>) => void;
|
|
32
36
|
/**
|
|
33
37
|
* Callback fired whenever an item is added or removed from the queuer
|
|
34
38
|
*/
|
|
35
|
-
|
|
39
|
+
onItemsChange?: (queuer: Queuer<TValue>) => void;
|
|
40
|
+
/**
|
|
41
|
+
* Callback fired whenever an item is rejected from being added to the queuer
|
|
42
|
+
*/
|
|
43
|
+
onReject?: (item: TValue, queuer: Queuer<TValue>) => void;
|
|
36
44
|
/**
|
|
37
45
|
* Whether the queuer should start processing tasks immediately
|
|
38
46
|
*/
|
|
@@ -73,7 +81,7 @@ export type QueuePosition = 'front' | 'back';
|
|
|
73
81
|
* - start(): begins processing items in the queuer
|
|
74
82
|
* - stop(): pauses processing
|
|
75
83
|
* - wait: configurable delay between processing items
|
|
76
|
-
* -
|
|
84
|
+
* - onItemsChange/onGetNextItem: callbacks for monitoring queuer state
|
|
77
85
|
*
|
|
78
86
|
* @example
|
|
79
87
|
* ```ts
|
|
@@ -88,7 +96,7 @@ export type QueuePosition = 'front' | 'back';
|
|
|
88
96
|
* getPriority: (n) => n, // Higher numbers have priority
|
|
89
97
|
* started: true, // Begin processing immediately
|
|
90
98
|
* wait: 1000, // Wait 1s between items
|
|
91
|
-
* onGetNextItem: (item) => console.log(item)
|
|
99
|
+
* onGetNextItem: (item, queuer) => console.log(item)
|
|
92
100
|
* });
|
|
93
101
|
* priorityQueue.addItem(1); // [1]
|
|
94
102
|
* priorityQueue.addItem(3); // [3, 1] - 3 processed first
|
|
@@ -96,22 +104,43 @@ export type QueuePosition = 'front' | 'back';
|
|
|
96
104
|
* ```
|
|
97
105
|
*/
|
|
98
106
|
export declare class Queuer<TValue> {
|
|
99
|
-
|
|
100
|
-
private
|
|
101
|
-
private
|
|
102
|
-
private
|
|
103
|
-
private
|
|
104
|
-
private
|
|
107
|
+
private _options;
|
|
108
|
+
private _items;
|
|
109
|
+
private _executionCount;
|
|
110
|
+
private _rejectionCount;
|
|
111
|
+
private _onItemsChanges;
|
|
112
|
+
private _running;
|
|
113
|
+
private _pendingTick;
|
|
105
114
|
constructor(initialOptions?: QueuerOptions<TValue>);
|
|
106
|
-
/**
|
|
107
|
-
* Processes items in the queuer
|
|
108
|
-
*/
|
|
109
|
-
protected tick(): void;
|
|
110
115
|
/**
|
|
111
116
|
* Updates the queuer options
|
|
112
117
|
* Returns the new options state
|
|
113
118
|
*/
|
|
114
119
|
setOptions(newOptions: Partial<QueuerOptions<TValue>>): QueuerOptions<TValue>;
|
|
120
|
+
/**
|
|
121
|
+
* Returns the current queuer options
|
|
122
|
+
*/
|
|
123
|
+
getOptions(): Required<QueuerOptions<TValue>>;
|
|
124
|
+
/**
|
|
125
|
+
* Processes items in the queuer
|
|
126
|
+
*/
|
|
127
|
+
private tick;
|
|
128
|
+
/**
|
|
129
|
+
* Stops the queuer from processing items
|
|
130
|
+
*/
|
|
131
|
+
stop(): void;
|
|
132
|
+
/**
|
|
133
|
+
* Starts the queuer and processes items
|
|
134
|
+
*/
|
|
135
|
+
start(): void;
|
|
136
|
+
/**
|
|
137
|
+
* Removes all items from the queuer
|
|
138
|
+
*/
|
|
139
|
+
clear(): void;
|
|
140
|
+
/**
|
|
141
|
+
* Resets the queuer to its initial state
|
|
142
|
+
*/
|
|
143
|
+
reset(withInitialItems?: boolean): void;
|
|
115
144
|
/**
|
|
116
145
|
* Adds an item to the queuer and starts processing if not already running
|
|
117
146
|
* @returns true if item was added, false if queuer is full
|
|
@@ -135,32 +164,24 @@ export declare class Queuer<TValue> {
|
|
|
135
164
|
* @example
|
|
136
165
|
* ```ts
|
|
137
166
|
* // Look at next item to getNextItem
|
|
138
|
-
* queuer.
|
|
167
|
+
* queuer.getPeek()
|
|
139
168
|
* // Look at last item (like stack top)
|
|
140
|
-
* queuer.
|
|
169
|
+
* queuer.getPeek('back')
|
|
141
170
|
* ```
|
|
142
171
|
*/
|
|
143
|
-
|
|
172
|
+
getPeek(position?: QueuePosition): TValue | undefined;
|
|
144
173
|
/**
|
|
145
174
|
* Returns true if the queuer is empty
|
|
146
175
|
*/
|
|
147
|
-
|
|
176
|
+
getIsEmpty(): boolean;
|
|
148
177
|
/**
|
|
149
178
|
* Returns true if the queuer is full
|
|
150
179
|
*/
|
|
151
|
-
|
|
180
|
+
getIsFull(): boolean;
|
|
152
181
|
/**
|
|
153
182
|
* Returns the current size of the queuer
|
|
154
183
|
*/
|
|
155
|
-
|
|
156
|
-
/**
|
|
157
|
-
* Removes all items from the queuer
|
|
158
|
-
*/
|
|
159
|
-
clear(): void;
|
|
160
|
-
/**
|
|
161
|
-
* Resets the queuer to its initial state
|
|
162
|
-
*/
|
|
163
|
-
reset(withInitialItems?: boolean): void;
|
|
184
|
+
getSize(): number;
|
|
164
185
|
/**
|
|
165
186
|
* Returns a copy of all items in the queuer
|
|
166
187
|
*/
|
|
@@ -170,25 +191,17 @@ export declare class Queuer<TValue> {
|
|
|
170
191
|
*/
|
|
171
192
|
getExecutionCount(): number;
|
|
172
193
|
/**
|
|
173
|
-
*
|
|
174
|
-
*/
|
|
175
|
-
onUpdate(cb: (item: TValue) => void): () => void;
|
|
176
|
-
/**
|
|
177
|
-
* Stops the queuer from processing items
|
|
194
|
+
* Returns the number of items that have been rejected from the queuer
|
|
178
195
|
*/
|
|
179
|
-
|
|
180
|
-
/**
|
|
181
|
-
* Starts the queuer and processes items
|
|
182
|
-
*/
|
|
183
|
-
start(): void;
|
|
196
|
+
getRejectionCount(): number;
|
|
184
197
|
/**
|
|
185
198
|
* Returns true if the queuer is running
|
|
186
199
|
*/
|
|
187
|
-
|
|
200
|
+
getIsRunning(): boolean;
|
|
188
201
|
/**
|
|
189
202
|
* Returns true if the queuer is running but has no items to process
|
|
190
203
|
*/
|
|
191
|
-
|
|
204
|
+
getIsIdle(): boolean;
|
|
192
205
|
}
|
|
193
206
|
/**
|
|
194
207
|
* Creates a queue that processes items in a queuer immediately upon addition.
|
|
@@ -204,7 +217,7 @@ export declare class Queuer<TValue> {
|
|
|
204
217
|
* // Basic sequential processing
|
|
205
218
|
* const processItems = queuer<number>({
|
|
206
219
|
* wait: 1000,
|
|
207
|
-
*
|
|
220
|
+
* onItemsChange: (queuer) => console.log(queuer.getAllItems())
|
|
208
221
|
* })
|
|
209
222
|
* processItems(1) // Logs: 1
|
|
210
223
|
* processItems(2) // Logs: 2 after 1 completes
|