ixfx
    Preparing search index...

    Interface IStack<V>

    Stack (immutable)

    Example: Overview

    stack.push(item); // Return a new stack with item(s) added
    stack.pop();      // Return a new stack with top-most item removed (ie. newest)
    stack.peek;       // Return what is at the top of the stack or undefined if empty
    stack.isEmpty;
    stack.isFull;
    stack.length;     // How many items in stack
    stack.data;       // Get the underlying array

    Example

    let sanga = new Stack();
    sanga = sanga.push(`bread`, `tomato`, `cheese`);
    sanga.peek;  // `cheese`
    sanga = sanga.pop(); // removes `cheese`
    sanga.peek;  // `tomato`
    const sangaAlt = sanga.push(`lettuce`, `cheese`); // sanga stays [`bread`, `tomato`], while sangaAlt is [`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. Stack

    interface IStack<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;
    }

    Type Parameters

    • V

      Type of stored items

    Hierarchy (View Summary)

    Accessors

    data isEmpty isFull length peek

    Methods

    forEach forEachFromTop

    Accessors

    data

    • get data(): readonly V[]

      Returns readonly V[]

    isEmpty

    • get isEmpty(): boolean

      True if stack is empty

      Returns boolean

    isFull

    • get isFull(): boolean

      True if stack is at its capacity. False if not, or if there is no capacity.

      Returns boolean

    length

    • get length(): number

      Number of items in stack

      Returns number

    peek

    • 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

    forEach

    • forEach(fn: (v: V) => void): void

      Enumerates stack from bottom-to-top

      Parameters

      • fn: (v: V) => void

      Returns void

    forEachFromTop

    • forEachFromTop(fn: (v: V) => void): void

      Enumerates stack from top-to-bottom

      Parameters

      • fn: (v: V) => void

      Returns void

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods