@common.js/yocto-queue 1.0.0 → 1.2.2

package/README.md

@@ -2,4 +2,4 @@
 
 The [yocto-queue](https://www.npmjs.com/package/yocto-queue) package exported as CommonJS modules.
 
-Exported from [yocto-queue@1.0.0](https://www.npmjs.com/package/yocto-queue/v/1.0.0) using https://github.com/etienne-martin/common.js.
+Exported from [yocto-queue@1.2.2](https://www.npmjs.com/package/yocto-queue/v/1.2.2) using https://github.com/etienne-martin/common.js.

package/index.d.ts

@@ -33,8 +33,22 @@ export default class Queue<ValueType> implements Iterable<ValueType> {
 	*/
 	constructor();
 
+	/**
+	The instance is an [`Iterable`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols), which means you can iterate over the queue front to back with a “for…of” loop. Using the iterator will not remove the items from the queue. If you want that, use `drain()` instead.
+ 
+	You can also use spreading to convert the queue to an array. Don't do this unless you really need to though, since it's slow.
+	*/
 	[Symbol.iterator](): IterableIterator<ValueType>;
 
+	/**
+	Returns an iterator that dequeues items as you consume it.
+
+	This allows you to empty the queue while processing its items.
+
+	If you want to not remove items as you consume it, use the `Queue` object as an iterator.
+	*/
+	drain(): IterableIterator<ValueType>;
+
 	/**
 	Add a value to the queue.
 	*/
@@ -47,6 +61,13 @@ export default class Queue<ValueType> implements Iterable<ValueType> {
 	*/
 	dequeue(): ValueType | undefined;
 
+	/**
+	Get the next value in the queue without removing it.
+
+	@returns The value or `undefined` if the queue is empty.
+	*/
+	peek(): ValueType | undefined;
+
 	/**
 	Clear the queue.
 	*/

package/index.js

@@ -253,9 +253,24 @@ var Queue = /*#__PURE__*/ function() {
                 }
                 _classPrivateFieldSet(this, _head, _classPrivateFieldGet(this, _head).next);
                 _classPrivateFieldUpdate(this, _size).value--;
+                // Clean up tail reference when queue becomes empty
+                if (!_classPrivateFieldGet(this, _head)) {
+                    _classPrivateFieldSet(this, _tail, undefined);
+                }
                 return current.value;
             }
         },
+        {
+            key: "peek",
+            value: function peek() {
+                if (!_classPrivateFieldGet(this, _head)) {
+                    return;
+                }
+                return _classPrivateFieldGet(this, _head).value;
+            // TODO: Node.js 18.
+            // return this.#head?.value;
+            }
+        },
         {
             key: "clear",
             value: function clear() {
@@ -302,6 +317,34 @@ var Queue = /*#__PURE__*/ function() {
                     }
                 });
             }
+        },
+        {
+            key: "drain",
+            value: function drain() {
+                return __generator(this, function(_state) {
+                    switch(_state.label){
+                        case 0:
+                            if (!_classPrivateFieldGet(this, _head)) return [
+                                3,
+                                2
+                            ];
+                            return [
+                                4,
+                                this.dequeue()
+                            ];
+                        case 1:
+                            _state.sent();
+                            return [
+                                3,
+                                0
+                            ];
+                        case 2:
+                            return [
+                                2
+                            ];
+                    }
+                });
+            }
         }
     ]);
     return Queue;

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@common.js/yocto-queue",
-  "version": "1.0.0",
-  "description": "Tiny queue data structure",
+  "version": "1.2.2",
+  "description": "yocto-queue package exported as CommonJS modules",
   "license": "MIT",
   "repository": "etienne-martin/common.js",
   "funding": "https://github.com/sponsors/sindresorhus",
   "type": "commonjs",
+  "types": "./index.d.ts",
+  "sideEffects": false,
   "engines": {
     "node": ">=12.20"
   },

package/readme.md

@@ -1,64 +0,0 @@
-# yocto-queue [![](https://badgen.net/bundlephobia/minzip/yocto-queue)](https://bundlephobia.com/result?p=yocto-queue)
-
-> Tiny queue data structure
-
-You should use this package instead of an array if you do a lot of `Array#push()` and `Array#shift()` on large arrays, since `Array#shift()` has [linear time complexity](https://medium.com/@ariel.salem1989/an-easy-to-use-guide-to-big-o-time-complexity-5dcf4be8a444#:~:text=O(N)%E2%80%94Linear%20Time) *O(n)* while `Queue#dequeue()` has [constant time complexity](https://medium.com/@ariel.salem1989/an-easy-to-use-guide-to-big-o-time-complexity-5dcf4be8a444#:~:text=O(1)%20%E2%80%94%20Constant%20Time) *O(1)*. That makes a huge difference for large arrays.
-
-> A [queue](https://en.wikipedia.org/wiki/Queue_(abstract_data_type)) is an ordered list of elements where an element is inserted at the end of the queue and is removed from the front of the queue. A queue works based on the first-in, first-out ([FIFO](https://en.wikipedia.org/wiki/FIFO_(computing_and_electronics))) principle.
-
-## Install
-
-```
-$ npm install yocto-queue
-```
-
-## Usage
-
-```js
-import Queue from 'yocto-queue';
-
-const queue = new Queue();
-
-queue.enqueue('🦄');
-queue.enqueue('🌈');
-
-console.log(queue.size);
-//=> 2
-
-console.log(...queue);
-//=> '🦄 🌈'
-
-console.log(queue.dequeue());
-//=> '🦄'
-
-console.log(queue.dequeue());
-//=> '🌈'
-```
-
-## API
-
-### `queue = new Queue()`
-
-The instance is an [`Iterable`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols), which means you can iterate over the queue front to back with a “for…of” loop, or use spreading to convert the queue to an array. Don't do this unless you really need to though, since it's slow.
-
-#### `.enqueue(value)`
-
-Add a value to the queue.
-
-#### `.dequeue()`
-
-Remove the next value in the queue.
-
-Returns the removed value or `undefined` if the queue is empty.
-
-#### `.clear()`
-
-Clear the queue.
-
-#### `.size`
-
-The size of the queue.
-
-## Related
-
-- [quick-lru](https://github.com/sindresorhus/quick-lru) - Simple “Least Recently Used” (LRU) cache