ixfx
    Preparing search index...

    Interface IStackMutable<V>

    Stack (mutable)

    stack.push(item); // Add one or more items to the top of the stack
    stack.pop(); // Removes and retiurns the item at the top of the stack (ie the newest thing)
    stack.peek; // Return what is at the top of the stack or undefined if empty
    stack.isEmpty/.isFull;
    stack.length; // How many items in stack
    stack.data; // Get the underlying array

    const sanga = new MutableStack();
    sanga.push(`bread`, `tomato`, `cheese`);
    sanga.peek;  // `cheese`
    sanga.pop(); // removes `cheese`
    sanga.peek;  // `tomato`
    sanga.push(`lettuce`, `cheese`); // Stack is now [`bread`, `tomato`, `lettuce`, `cheese`]

    Stack can also be created from the basis of an existing array. First index of array will be the bottom of the stack.

    interface IStackMutable<V> {
        get data(): readonly V[];
        get isEmpty(): boolean;
        get isFull(): boolean;
        get length(): number;
        get peek(): undefined | V;
        forEach(fn: (v: V) => void): void;
        forEachFromTop(fn: (v: V) => void): void;
        pop(): undefined | V;
        push(...toAdd: readonly V[]): number;
    }

    Type Parameters

    • V

      Type of stored items

    Hierarchy (View Summary)

    Implemented by

    Index

    Accessors

    data isEmpty isFull length peek

    Methods

    forEach forEachFromTop pop push

    Accessors

    • get peek(): undefined | V

      Get the item at the top of the stack without removing it (like pop would do)

      Returns undefined | V

      Item at the top of the stack, or undefined if empty.

    Methods

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods