@figliolia/data-structures/dist/cjs/QuickStack.js

Efficient data structures for every day programming

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.QuickStack = void 0;
const QuickList_1 = require("./QuickList");
/**
 * Quick Stack
 *
 * A wrapper around the native Map that assigns an
 * auto-incrementing ID to each value added. It provides
 * a Stack-like interface with the ability to access and
 * remove items in 0(1) time
 *
 * ```typescript
 * const stack = new QuickStack<() => void>();
 * const uniqueID = stack.push(() => {});
 *
 * const FN = stack.pop() // Remove and return the first item on the stack
 * const FN = stack.get(uniqueID); // Get an entry by ID
 * stack.delete(uniqueID) // Delete an entry by ID
 * ```
 */
class QuickStack extends QuickList_1.QuickList {
    /**
     * Pop
     *
     * Removes and returns the top entry in the stack
     */
    pop() {
        for (const [ID, item] of this) {
            this.delete(ID);
            return item;
        }
    }
    /**
     * Peek
     *
     * Returns the top entry in the stack
     */
    peek() {
        for (const entry of this) {
            return entry;
        }
    }
    // @ts-ignore
    *[Symbol.iterator]() {
        const items = Array.from(this.storage.entries());
        const { length } = items;
        for (let i = length - 1; i > -1; i--) {
            yield items[i];
        }
    }
}
exports.QuickStack = QuickStack;