ixfx
    Preparing search index...

    Class StackMutable<V>

    Creates a stack. Mutable. Use StackImmutable for an immutable alternative.

    Example: Basic usage

    // Create
    const s = new StackMutable();
    // Add one or more items
    s.push(1, 2, 3, 4);

    // See what's on top
    s.peek;  // 4

    // Remove the top-most, and return it
    s.pop();   // 4

    // Now there's a new top-most element
    s.peek;  // 3

    Type Parameters

    • V

    Implements

    Constructors

    constructor

    Properties

    data opts

    Accessors

    isEmpty isFull length peek

    Methods

    forEach forEachFromTop pop push

    Constructors

    constructor

    Properties

    data

    data: readonly V[]

    Readonlyopts

    opts: StackOpts

    Accessors

    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

    pop

    • pop(): undefined | V

      Remove and return item from the top of the stack, or undefined if empty. If you just want to find out what's at the top, use peek.

      Returns undefined | V

    push

    • push(...toAdd: readonly V[]): number

      Push data onto the stack. If toAdd is empty, nothing happens

      Parameters

      • ...toAdd: readonly V[]

        Data to add

      Returns number

      Length of stack

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods