@rhombus-toolkit/collections 2.0.2 → 2.1.0

package/dist/bundle/index.d.ts

@@ -1,3 +1,22 @@
+/**
+ * A stack whose entries leave when their scope does.
+ *
+ * @remarks
+ * Iterates outermost first.
+ */
+declare class AutoStack<T> implements Iterable<T> {
+    #private;
+    /** How many entries the stack holds. */
+    get length(): number;
+    /** Adds `item`; disposing the return truncates back to the pre-push depth, so an outer scope's dispose also drops what an inner one left. */
+    push(item: T): Disposable;
+    /** Whether `item` sits anywhere in the stack, not only at the top. */
+    has(item: T): boolean;
+    /** The innermost entry, absent where the stack holds nothing. */
+    peek(): T | undefined;
+    [Symbol.iterator](): ArrayIterator<T>;
+}
+
 /**
  * A persistent singly-linked list — extending shares everything already there.
  *
@@ -46,4 +65,4 @@ declare class KindaWeakMap<K, V extends WeakKey> {
     readonly [Symbol.toStringTag]: "KindaWeakMap";
 }
 
-export { ImmutableLinkedList, KindaWeakMap };
+export { AutoStack, ImmutableLinkedList, KindaWeakMap };

package/dist/bundle/index.js

@@ -1,3 +1,26 @@
+// src/AutoStack.ts
+class AutoStack {
+  #items = [];
+  get length() {
+    return this.#items.length;
+  }
+  push(item) {
+    const pos = this.#items.length;
+    this.#items.push(item);
+    return { [Symbol.dispose]: () => {
+      this.#items.length = pos;
+    } };
+  }
+  has(item) {
+    return this.#items.includes(item);
+  }
+  peek() {
+    return this.#items.at(-1);
+  }
+  [Symbol.iterator]() {
+    return this.#items.values();
+  }
+}
 // src/ImmutableLinkedList.ts
 class ImmutableLinkedList {
   static #nothing = new ImmutableLinkedList(undefined, undefined, 0);
@@ -118,6 +141,7 @@ class KindaWeakMap {
   [Symbol.toStringTag] = "KindaWeakMap";
 }
 export {
+  AutoStack,
   ImmutableLinkedList,
   KindaWeakMap
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rhombus-toolkit/collections",
-  "version": "2.0.2",
-  "description": "Collection data structures: ImmutableLinkedList (persistent, both ends known), KindaWeakMap (strong keys, weak values).",
+  "version": "2.1.0",
+  "description": "Collection data structures: AutoStack (entries leave with their scope), ImmutableLinkedList (persistent, both ends known), KindaWeakMap (strong keys, weak values).",
   "repository": {
     "type": "git",
     "url": "https://github.com/rhombus-toolkit/ts.git",