@common.js/yocto-queue 1.1.1 → 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.1.1](https://www.npmjs.com/package/yocto-queue/v/1.1.1) 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.
 	*/

package/index.js

@@ -253,6 +253,10 @@ 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;
             }
         },
@@ -313,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,6 +1,6 @@
 {
   "name": "@common.js/yocto-queue",
-  "version": "1.1.1",
+  "version": "1.2.2",
   "description": "yocto-queue package exported as CommonJS modules",
   "license": "MIT",
   "repository": "etienne-martin/common.js",